Skip to content

Reference

OpcClient.ReadNodesHistory Method

Reads the historical values of the nodes identified by the nodeIds specified using the details specified to select the values.

Reference

OpcClient.ReadNodesHistory Method ​

Type
OpcClient
Namespace
Opc.UaFx.Client
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Members
OpcClient Members
Also in
Opc.UaFx.Client

17 overloads

OverloadDescription
ReadNodesHistory(IEnumerable<OpcNodeId>, OpcReadHistoryDetails)since v2.23Reads the historical values of the nodes identified by the nodeIds specified using the details specified to select the values.
ReadNodesHistory(int, IEnumerable<OpcNodeId>)Reads the raw historical values of the nodes identified by the nodeIds specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, int, IEnumerable<OpcNodeId>)Reads the raw historical values of the nodes identified by the nodeIds specified beginning at the startTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, DateTime?, int, IEnumerable<OpcNodeId>)Reads the raw historical values of the nodes identified by the nodeIds specified within the period defined by the startTime and endTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, DateTime?, IEnumerable<OpcNodeId>)Reads the raw historical values of the nodes identified by the nodeIds specified within the period defined by the startTime and endTime specified.
ReadNodesHistory(int, params OpcNodeId[])Reads the raw historical values of the nodes identified by the nodeIds specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, int, params OpcNodeId[])Reads the raw historical values of the nodes identified by the nodeIds specified beginning at the startTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, DateTime?, int, params OpcNodeId[])Reads the raw historical values of the nodes identified by the nodeIds specified within the period defined by the startTime and endTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, DateTime?, params OpcNodeId[])Reads the raw historical values of the nodes identified by the nodeIds specified within the period defined by the startTime and endTime specified.
ReadNodesHistory(int, IEnumerable<OpcReadNodeHistory>)Reads the raw historical values of the nodes as defined by the commands specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, int, IEnumerable<OpcReadNodeHistory>)Reads the raw historical values of the nodes as defined by the commands specified beginning at the startTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, DateTime?, int, IEnumerable<OpcReadNodeHistory>)Reads the raw historical values of the nodes as defined by the commands specified within the period defined by the startTime and endTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, DateTime?, IEnumerable<OpcReadNodeHistory>)Reads the raw historical values of the nodes as defined by the commands specified within the period defined by the startTime and endTime specified.
ReadNodesHistory(int, params OpcReadNodeHistory[])Reads the raw historical values of the nodes as defined by the commands specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, int, params OpcReadNodeHistory[])Reads the raw historical values of the nodes as defined by the commands specified beginning at the startTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, DateTime?, int, params OpcReadNodeHistory[])Reads the raw historical values of the nodes as defined by the commands specified within the period defined by the startTime and endTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.
ReadNodesHistory(DateTime?, DateTime?, params OpcReadNodeHistory[])Reads the raw historical values of the nodes as defined by the commands specified within the period defined by the startTime and endTime specified.

Exceptions (all overloads)

ExceptionCondition
OpcExceptionThe client is not connected to the server or the service execution failed upon different circumstances; for more details see exception details.
ObjectDisposedExceptionThe object has been disposed of.

ReadNodesHistory(IEnumerable<OpcNodeId>, OpcReadHistoryDetails) ​

since v2.23

Reads the historical values of the nodes identified by the nodeIds specified using the details specified to select the values.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    IEnumerable<OpcNodeId> nodeIds,
    OpcReadHistoryDetails details)
vbnet
Public Function ReadNodesHistory(
    nodeIds As IEnumerable(Of OpcNodeId),
    details As OpcReadHistoryDetails) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
nodeIdsIEnumerable<OpcNodeId>A sequence of the OpcNodeId instances of the nodes whose history is to be read.
detailsOpcReadHistoryDetailsThe OpcReadHistoryDetails which define the criteria to use to select the historical values.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the items of the nodeIds is a null identifier (see IsNull) or the details is an instance of the OpcReadNodeHistoryModifiedDetails class; to read modified values use ReadNodeHistoryModified.
ArgumentNullExceptionThe nodeIds sequence or one of its items or the details is a null reference (Nothing in Visual Basic).

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(int, IEnumerable<OpcNodeId>) ​

Reads the raw historical values of the nodes identified by the nodeIds specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    int numberOfValues,
    IEnumerable<OpcNodeId> nodeIds)
vbnet
Public Function ReadNodesHistory(
    numberOfValues As Integer,
    nodeIds As IEnumerable(Of OpcNodeId)) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
numberOfValuesInt32The maximum number of values returned for each node per page.
nodeIdsIEnumerable<OpcNodeId>A sequence of the OpcNodeId instances of the nodes whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the items of the nodeIds is a null identifier (see IsNull).
ArgumentNullExceptionThe nodeIds sequence or one of its items is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, int, IEnumerable<OpcNodeId>) ​

Reads the raw historical values of the nodes identified by the nodeIds specified beginning at the startTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    DateTime? startTime,
    int numberOfValues,
    IEnumerable<OpcNodeId> nodeIds)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    numberOfValues As Integer,
    nodeIds As IEnumerable(Of OpcNodeId)) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read.
numberOfValuesInt32The maximum number of values returned for each node per page. If only one time is specified, the time range shall extend to return this number of values.
nodeIdsIEnumerable<OpcNodeId>A sequence of the OpcNodeId instances of the nodes whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the items of the nodeIds is a null identifier (see IsNull) or the startTime is a null reference (Nothing in Visual Basic) or equals MinValue.
ArgumentNullExceptionThe nodeIds sequence or one of its items is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, DateTime?, int, IEnumerable<OpcNodeId>) ​

Reads the raw historical values of the nodes identified by the nodeIds specified within the period defined by the startTime and endTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    DateTime? startTime,
    DateTime? endTime,
    int numberOfValues,
    IEnumerable<OpcNodeId> nodeIds)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    endTime As Date?,
    numberOfValues As Integer,
    nodeIds As IEnumerable(Of OpcNodeId)) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified and the numberOfValues is equals zero the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified and the numberOfValues is equals zero the startTime needs to be specified.
numberOfValuesInt32The maximum number of values returned for each node per page. If only one time is specified, the time range shall extend to return this number of values.
nodeIdsIEnumerable<OpcNodeId>A sequence of the OpcNodeId instances of the nodes whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the items of the nodeIds is a null identifier (see IsNull) or the startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue and numberOfValues is lower or equals zero.
ArgumentNullExceptionThe nodeIds sequence or one of its items is a null reference (Nothing in Visual Basic).

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, DateTime?, IEnumerable<OpcNodeId>) ​

Reads the raw historical values of the nodes identified by the nodeIds specified within the period defined by the startTime and endTime specified.

csharp
public IDictionary<OpcNodeId, IEnumerable<OpcHistoryValue>> ReadNodesHistory(
    DateTime? startTime,
    DateTime? endTime,
    IEnumerable<OpcNodeId> nodeIds)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    endTime As Date?,
    nodeIds As IEnumerable(Of OpcNodeId)) As IDictionary(Of OpcNodeId, IEnumerable(Of OpcHistoryValue))

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified the startTime needs to be specified.
nodeIdsIEnumerable<OpcNodeId>A sequence of the OpcNodeId instances of the nodes whose history is to be read.

Returns

IDictionary<OpcNodeId, IEnumerable<OpcHistoryValue>>

A dictionary which provides for each node, identified by the OpcNodeId specified, the sequence of the OpcHistoryValue instances read for the node.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the items of the nodeIds is a null identifier (see IsNull) or the startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue.
ArgumentNullExceptionThe nodeIds sequence or one of its items is a null reference (Nothing in Visual Basic).

Remarks

All values within the period are read, also if the server provides them using multiple responses. A node for which no values have been read, also because the server reports a bad status code for it, is not contained in the dictionary.

ReadNodesHistory(int, params OpcNodeId[]) ​

Reads the raw historical values of the nodes identified by the nodeIds specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    int numberOfValues,
    params OpcNodeId[] nodeIds)
vbnet
Public Function ReadNodesHistory(
    numberOfValues As Integer,
    ParamArray nodeIds As OpcNodeId()) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
numberOfValuesInt32The maximum number of values returned for each node per page.
nodeIdsparams OpcNodeId[]An array of the OpcNodeId instances of the nodes whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the items of the nodeIds is a null identifier (see IsNull).
ArgumentNullExceptionThe nodeIds array or one of its items is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, int, params OpcNodeId[]) ​

Reads the raw historical values of the nodes identified by the nodeIds specified beginning at the startTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    DateTime? startTime,
    int numberOfValues,
    params OpcNodeId[] nodeIds)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    numberOfValues As Integer,
    ParamArray nodeIds As OpcNodeId()) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read.
numberOfValuesInt32The maximum number of values returned for each node per page. If only one time is specified, the time range shall extend to return this number of values.
nodeIdsparams OpcNodeId[]An array of the OpcNodeId instances of the nodes whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the items of the nodeIds is a null identifier (see IsNull) or the startTime is a null reference (Nothing in Visual Basic) or equals MinValue.
ArgumentNullExceptionThe nodeIds array or one of its items is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, DateTime?, int, params OpcNodeId[]) ​

Reads the raw historical values of the nodes identified by the nodeIds specified within the period defined by the startTime and endTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    DateTime? startTime,
    DateTime? endTime,
    int numberOfValues,
    params OpcNodeId[] nodeIds)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    endTime As Date?,
    numberOfValues As Integer,
    ParamArray nodeIds As OpcNodeId()) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified and the numberOfValues is equals zero the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified and the numberOfValues is equals zero the startTime needs to be specified.
numberOfValuesInt32The maximum number of values returned for each node per page. If only one time is specified, the time range shall extend to return this number of values.
nodeIdsparams OpcNodeId[]An array of the OpcNodeId instances of the nodes whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the items of the nodeIds is a null identifier (see IsNull) or the startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue and numberOfValues is lower or equals zero.
ArgumentNullExceptionThe nodeIds array or one of its items is a null reference (Nothing in Visual Basic).

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, DateTime?, params OpcNodeId[]) ​

Reads the raw historical values of the nodes identified by the nodeIds specified within the period defined by the startTime and endTime specified.

csharp
public IDictionary<OpcNodeId, IEnumerable<OpcHistoryValue>> ReadNodesHistory(
    DateTime? startTime,
    DateTime? endTime,
    params OpcNodeId[] nodeIds)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    endTime As Date?,
    ParamArray nodeIds As OpcNodeId()) As IDictionary(Of OpcNodeId, IEnumerable(Of OpcHistoryValue))

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified the startTime needs to be specified.
nodeIdsparams OpcNodeId[]An array of the OpcNodeId instances of the nodes whose history is to be read.

Returns

IDictionary<OpcNodeId, IEnumerable<OpcHistoryValue>>

A dictionary which provides for each node, identified by the OpcNodeId specified, the sequence of the OpcHistoryValue instances read for the node.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the items of the nodeIds is a null identifier (see IsNull) or the startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue.
ArgumentNullExceptionThe nodeIds array or one of its items is a null reference (Nothing in Visual Basic).

Remarks

All values within the period are read, also if the server provides them using multiple responses. A node for which no values have been read, also because the server reports a bad status code for it, is not contained in the dictionary.

ReadNodesHistory(int, IEnumerable<OpcReadNodeHistory>) ​

Reads the raw historical values of the nodes as defined by the commands specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    int numberOfValues,
    IEnumerable<OpcReadNodeHistory> commands)
vbnet
Public Function ReadNodesHistory(
    numberOfValues As Integer,
    commands As IEnumerable(Of OpcReadNodeHistory)) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
numberOfValuesInt32The maximum number of values returned for each node per page.
commandsIEnumerable<OpcReadNodeHistory>A sequence of OpcReadNodeHistory commands, each defining a node whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe commands sequence or one of its items is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, int, IEnumerable<OpcReadNodeHistory>) ​

Reads the raw historical values of the nodes as defined by the commands specified beginning at the startTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    DateTime? startTime,
    int numberOfValues,
    IEnumerable<OpcReadNodeHistory> commands)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    numberOfValues As Integer,
    commands As IEnumerable(Of OpcReadNodeHistory)) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read.
numberOfValuesInt32The maximum number of values returned for each node per page. If only one time is specified, the time range shall extend to return this number of values.
commandsIEnumerable<OpcReadNodeHistory>A sequence of OpcReadNodeHistory commands, each defining a node whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionThe startTime is a null reference (Nothing in Visual Basic) or equals MinValue.
ArgumentNullExceptionThe commands sequence or one of its items is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, DateTime?, int, IEnumerable<OpcReadNodeHistory>) ​

Reads the raw historical values of the nodes as defined by the commands specified within the period defined by the startTime and endTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    DateTime? startTime,
    DateTime? endTime,
    int numberOfValues,
    IEnumerable<OpcReadNodeHistory> commands)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    endTime As Date?,
    numberOfValues As Integer,
    commands As IEnumerable(Of OpcReadNodeHistory)) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified and the numberOfValues is equals zero the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified and the numberOfValues is equals zero the startTime needs to be specified.
numberOfValuesInt32The maximum number of values returned for each node per page. If only one time is specified, the time range shall extend to return this number of values.
commandsIEnumerable<OpcReadNodeHistory>A sequence of OpcReadNodeHistory commands, each defining a node whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionThe startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue and numberOfValues is lower or equals zero.
ArgumentNullExceptionThe commands sequence or one of its items is a null reference (Nothing in Visual Basic).

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, DateTime?, IEnumerable<OpcReadNodeHistory>) ​

Reads the raw historical values of the nodes as defined by the commands specified within the period defined by the startTime and endTime specified.

csharp
public IDictionary<OpcNodeId, IEnumerable<OpcHistoryValue>> ReadNodesHistory(
    DateTime? startTime,
    DateTime? endTime,
    IEnumerable<OpcReadNodeHistory> commands)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    endTime As Date?,
    commands As IEnumerable(Of OpcReadNodeHistory)) As IDictionary(Of OpcNodeId, IEnumerable(Of OpcHistoryValue))

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified the startTime needs to be specified.
commandsIEnumerable<OpcReadNodeHistory>A sequence of OpcReadNodeHistory commands, each defining a node whose history is to be read.

Returns

IDictionary<OpcNodeId, IEnumerable<OpcHistoryValue>>

A dictionary which provides for each node, identified by the NodeId of its command, the sequence of the OpcHistoryValue instances read for the node.

Exceptions

ExceptionCondition
ArgumentExceptionThe startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue.
ArgumentNullExceptionThe commands sequence or one of its items is a null reference (Nothing in Visual Basic).

Remarks

All values within the period are read, also if the server provides them using multiple responses. A node for which no values have been read, also because the server reports a bad status code for it, is not contained in the dictionary.

ReadNodesHistory(int, params OpcReadNodeHistory[]) ​

Reads the raw historical values of the nodes as defined by the commands specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    int numberOfValues,
    params OpcReadNodeHistory[] commands)
vbnet
Public Function ReadNodesHistory(
    numberOfValues As Integer,
    ParamArray commands As OpcReadNodeHistory()) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
numberOfValuesInt32The maximum number of values returned for each node per page.
commandsparams OpcReadNodeHistory[]An array of OpcReadNodeHistory commands, each defining a node whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe commands array or one of its items is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, int, params OpcReadNodeHistory[]) ​

Reads the raw historical values of the nodes as defined by the commands specified beginning at the startTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    DateTime? startTime,
    int numberOfValues,
    params OpcReadNodeHistory[] commands)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    numberOfValues As Integer,
    ParamArray commands As OpcReadNodeHistory()) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read.
numberOfValuesInt32The maximum number of values returned for each node per page. If only one time is specified, the time range shall extend to return this number of values.
commandsparams OpcReadNodeHistory[]An array of OpcReadNodeHistory commands, each defining a node whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionThe startTime is a null reference (Nothing in Visual Basic) or equals MinValue.
ArgumentNullExceptionThe commands array or one of its items is a null reference (Nothing in Visual Basic).
ArgumentOutOfRangeExceptionThe numberOfValues is lower or equals zero.

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, DateTime?, int, params OpcReadNodeHistory[]) ​

Reads the raw historical values of the nodes as defined by the commands specified within the period defined by the startTime and endTime specified page by page using the numberOfValues specified as the maximum number of values per page and node.

csharp
public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodesHistory(
    DateTime? startTime,
    DateTime? endTime,
    int numberOfValues,
    params OpcReadNodeHistory[] commands)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    endTime As Date?,
    numberOfValues As Integer,
    ParamArray commands As OpcReadNodeHistory()) As IOpcNodeHistoryNavigator(Of OpcHistoryValue)

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified and the numberOfValues is equals zero the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified and the numberOfValues is equals zero the startTime needs to be specified.
numberOfValuesInt32The maximum number of values returned for each node per page. If only one time is specified, the time range shall extend to return this number of values.
commandsparams OpcReadNodeHistory[]An array of OpcReadNodeHistory commands, each defining a node whose history is to be read.

Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>

An instance implementing the IOpcNodeHistoryNavigator<T> interface which provides the first page of the historical values read for the nodes, the values of a specific node using its Item indexer and further pages using its MoveNextPage method.

Exceptions

ExceptionCondition
ArgumentExceptionThe startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue and numberOfValues is lower or equals zero.
ArgumentNullExceptionThe commands array or one of its items is a null reference (Nothing in Visual Basic).

Remarks

In case there the server reports a bad status code for a node, the navigator provides no values for that node instead of throwing an exception.

ReadNodesHistory(DateTime?, DateTime?, params OpcReadNodeHistory[]) ​

Reads the raw historical values of the nodes as defined by the commands specified within the period defined by the startTime and endTime specified.

csharp
public IDictionary<OpcNodeId, IEnumerable<OpcHistoryValue>> ReadNodesHistory(
    DateTime? startTime,
    DateTime? endTime,
    params OpcReadNodeHistory[] commands)
vbnet
Public Function ReadNodesHistory(
    startTime As Date?,
    endTime As Date?,
    ParamArray commands As OpcReadNodeHistory()) As IDictionary(Of OpcNodeId, IEnumerable(Of OpcHistoryValue))

Parameters

NameTypeDescription
startTimeNullable<DateTime>The beginning of the period to read or a null reference (Nothing in Visual Basic) if no specific start time is specified. If startTime is not specified the endTime needs to be specified.
endTimeNullable<DateTime>The end of the period to read or a null reference (Nothing in Visual Basic) if no specific end time is specified. If endTime is not specified the startTime needs to be specified.
commandsparams OpcReadNodeHistory[]An array of OpcReadNodeHistory commands, each defining a node whose history is to be read.

Returns

IDictionary<OpcNodeId, IEnumerable<OpcHistoryValue>>

A dictionary which provides for each node, identified by the NodeId of its command, the sequence of the OpcHistoryValue instances read for the node.

Exceptions

ExceptionCondition
ArgumentExceptionThe startTime and endTime are a null reference (Nothing in Visual Basic) or are equals MinValue.
ArgumentNullExceptionThe commands array or one of its items is a null reference (Nothing in Visual Basic).

Remarks

All values within the period are read, also if the server provides them using multiple responses. A node for which no values have been read, also because the server reports a bad status code for it, is not contained in the dictionary.