Skip to content

Reference

OpcClient.RegisterNodes Method

Registers one or more nodes for optimized node access using the specified commands.

Reference

OpcClient.RegisterNodes 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

4 overloads · since v2.8

OverloadDescription
RegisterNodes(IEnumerable<OpcRegisterNode>)since v2.8Registers one or more nodes for optimized node access using the specified commands.
RegisterNodes(params OpcRegisterNode[])since v2.8Registers one or more nodes for optimized node access using the specified commands.
RegisterNodes(IEnumerable<OpcNodeId>)since v2.8Registers one or more nodes for optimized node access using the identifiers of the nodes its access shall be optimized.
RegisterNodes(params OpcNodeId[])since v2.8Registers one or more nodes for optimized node access using the identifiers of the nodes its access shall be optimized.

Known results: BadNodeIdInvalid

Exceptions (all overloads)

ExceptionCondition
ObjectDisposedExceptionThe object has been disposed of.

RegisterNodes(IEnumerable<OpcRegisterNode>) ​

since v2.8

Registers one or more nodes for optimized node access using the specified commands.

csharp
public OpcNodeIdCollection RegisterNodes(IEnumerable<OpcRegisterNode> commands)
vbnet
Public Function RegisterNodes(
    commands As IEnumerable(Of OpcRegisterNode)) As OpcNodeIdCollection

Parameters

NameTypeDescription
commandsIEnumerable<OpcRegisterNode>A sequence of OpcRegisterNode instances to process.

Returns

OpcNodeIdCollection

A collection of OpcNodeId instances its number and order of items matches the number and order of items in the commands sequence. There is for each command one entry which stores the node identifier requested by that command to use to access the node registered for optimized node access.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe commands sequence or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe register nodes service is currently not supported, especially using the commands specified.
OpcExceptionThe service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyMatches.

Remarks

Servers completely reject register nodes requests if any of the node identifiers passed are structurally invalid.

RegisterNodes(params OpcRegisterNode[]) ​

since v2.8

Registers one or more nodes for optimized node access using the specified commands.

csharp
public OpcNodeIdCollection RegisterNodes(params OpcRegisterNode[] commands)
vbnet
Public Function RegisterNodes(
    ParamArray commands As OpcRegisterNode()) As OpcNodeIdCollection

Parameters

NameTypeDescription
commandsparams OpcRegisterNode[]A sequence of OpcRegisterNode instances to process.

Returns

OpcNodeIdCollection

A collection of OpcNodeId instances its number and order of items matches the number and order of items in the commands sequence. There is for each command one entry which stores the node identifier requested by that command to use to access the node registered for optimized node access.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe commands sequence or one of its items is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe register nodes service is currently not supported, especially using the commands specified.
OpcExceptionThe service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyMatches.

Remarks

Servers completely reject register nodes requests if any of the node identifiers passed are structurally invalid.

RegisterNodes(IEnumerable<OpcNodeId>) ​

since v2.8

Registers one or more nodes for optimized node access using the identifiers of the nodes its access shall be optimized. One registered nodes have to be unregistered as soon as the optimized node access is not longer required. This assures that the server can release unused resources reserved for the optimized node access.

csharp
public OpcNodeIdCollection RegisterNodes(IEnumerable<OpcNodeId> nodeIds)
vbnet
Public Function RegisterNodes(
    nodeIds As IEnumerable(Of OpcNodeId)) As OpcNodeIdCollection

Parameters

NameTypeDescription
nodeIdsIEnumerable<OpcNodeId>A sequence of OpcNodeId instances through that the nodes to register can be identified.

Returns

OpcNodeIdCollection

A collection of OpcNodeId instances its items are to be used for subsequent optimized node access. Use these identifiers to release unused resources assoicated with the optimized node access using UnregisterNodes as soon as the optimized node access is not longer required.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the OpcNodeId instances in nodeIds is equals Null.
ArgumentNullExceptionThe nodeIds is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe register node service is currently not supported, especially using the parameters specified.
OpcExceptionThe service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.

Remarks

Servers completely reject register nodes requests if any of the node identifiers passed are structurally invalid.

RegisterNodes(params OpcNodeId[]) ​

since v2.8

Registers one or more nodes for optimized node access using the identifiers of the nodes its access shall be optimized. One registered nodes have to be unregistered as soon as the optimized node access is not longer required. This assures that the server can release unused resources reserved for the optimized node access.

csharp
public OpcNodeIdCollection RegisterNodes(params OpcNodeId[] nodeIds)
vbnet
Public Function RegisterNodes(
    ParamArray nodeIds As OpcNodeId()) As OpcNodeIdCollection

Parameters

NameTypeDescription
nodeIdsparams OpcNodeId[]An array of OpcNodeId instances through that the nodes to register can be identified.

Returns

OpcNodeIdCollection

A collection of OpcNodeId instances its items are to be used for subsequent optimized node access. Use these identifiers to release unused resources assoicated with the optimized node access using UnregisterNodes as soon as the optimized node access is not longer required.

Exceptions

ExceptionCondition
ArgumentExceptionOne of the OpcNodeId instances in nodeIds is equals Null.
ArgumentNullExceptionThe nodeIds is a null reference (Nothing in Visual Basic).
InvalidOperationExceptionThe register node service is currently not supported, especially using the parameters specified.
OpcExceptionThe service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.

Remarks

Servers completely reject register nodes requests if any of the node identifiers passed are structurally invalid.