OpcClient Members

Namespace: Opc.UaFx.Client
Assemblies: Opc.UaFx.Advanced.dll, Opc.UaFx.Advanced.dll
The OpcClient type exposes the following members.

OpcClient()

Initializes a new instance of the OpcClient class.

C#

public OpcClient()

OpcClient(String)

Initializes a new instance of the OpcClient class using the specified serverAddress.

C#

public OpcClient(string serverAddress)


Parameters

serverAddress String

The URI of the OPC UA server to operate on.


Exceptions

ArgumentException

The serverAddress is an empty string.

ArgumentNullException

The serverAddress is a null reference (Nothing in Visual Basic).

UriFormatException

The serverAddress is not a valid URI.

OpcClient(String, OpcSecurityPolicy)

Initializes a new instance of the OpcClient class using the specified serverAddress and endpointPolicy.

C#

public OpcClient(string serverAddress, OpcSecurityPolicy endpointPolicy)


Parameters

serverAddress String

The URI of the OPC UA server to operate on.

endpointPolicy OpcSecurityPolicy

The preferred security policy configuration which is to be provided by one of the endpoints defined by the server to operate on.


Exceptions

ArgumentException

The serverAddress is an empty string.

ArgumentNullException

The serverAddress or endpointPolicy is a null reference (Nothing in Visual Basic).

UriFormatException

The serverAddress is not a valid URI.

OpcClient(Uri)

Initializes a new instance of the OpcClient class using the specified serverAddress.

C#

public OpcClient(Uri serverAddress)


Parameters

serverAddress Uri

The Uri of the OPC UA server to operate on.


Exceptions

ArgumentNullException

The serverAddress is a null reference (Nothing in Visual Basic).

OpcClient(Uri, OpcSecurityPolicy)

Initializes a new instance of the OpcClient class using the specified serverAddress and endpointPolicy.

C#

public OpcClient(Uri serverAddress, OpcSecurityPolicy endpointPolicy)


Parameters

serverAddress Uri

The Uri of the OPC UA server to operate on.

endpointPolicy OpcSecurityPolicy

The preferred security policy configuration which is to be provided by one of the endpoints defined by the server to operate on.


Exceptions

ArgumentNullException

The serverAddress or endpointPolicy is a null reference (Nothing in Visual Basic).

DefaultDisconnectTimeout

Represents the default timeout value that is used by the OpcClient as initial value of the DisconnectTimeout property.

C#

public static readonly int DefaultDisconnectTimeout


Field Value
Int32

DefaultOperationTimeout

Represents the default timeout value that is used by the OpcClient as initial value of the OperationTimeout property.

C#

public static readonly int DefaultOperationTimeout


Field Value
Int32

DefaultReconnectTimeout

Represents the default timeout value that is used by the OpcClient as initial value of the ReconnectTimeout property.

C#

public static readonly int DefaultReconnectTimeout


Field Value
Int32

DefaultSessionTimeout

Represents the default timeout value that is used by the OpcClient as initial value of the SessionTimeout property.

C#

public static readonly int DefaultSessionTimeout


Field Value
Int32

BreakDetected

Occurs when a connection break has been detected.

C#

public event EventHandler BreakDetected

CertificateJudgement

Occurs when the validation of a opponent application instance certificate has already fulfilled the requirements for valid and trusted certificates, but while being connected the server may behave different regarding its initially offered certificate.

C#

public event OpcCertificateJudgementEventHandler CertificateJudgement


Remarks

This event can be used to substitute the default judgement of such potential suspect situations which would otherwise throw an exception.

Connected

Occurs when the OpcClient has successfully established a connection to the server.

C#

public event EventHandler Connected

Connecting

Occurs when the OpcClient is about to establish a connection to the server.

C#

public event EventHandler Connecting

DataChangeReceived

C#

public event OpcDataChangeReceivedEventHandler DataChangeReceived

DialogRequested

Occurs when a monitored item receives an OpcDialogCondition event notification which is not handled by any OpcEventReceivedEventHandler and can be therefore used to explictly respond to OpcDialogCondition events.

C#

public event OpcDialogRequestedEventHandler DialogRequested


Remarks

This event only occurs if an event is not handled by the according EventReceived handler, not handled by the EventReceived handler of the OpcSubscription of the OpcMonitoredItem and also not handled by the OpcClient through its EventReceived handler which owns the OpcSubscription.

Disconnected

Occurs when the OpcClient has successfully terminated a connection to the server.

C#

public event EventHandler Disconnected

Disconnecting

Occurs when the OpcClient is about to terminate a connection to the server.

C#

public event EventHandler Disconnecting

EventReceived

Occurs when a monitored item receives an event notification which is not handled by any other OpcEventReceivedEventHandler.

C#

public event OpcEventReceivedEventHandler EventReceived


Remarks

This event only occurs if an event is not handled by the according EventReceived handler and also not handled by the EventReceived handler of the OpcSubscription of the OpcMonitoredItem.

NotificationReceived

Occurs when the OpcClient received a notification message form the server connected to.

C#

public event OpcNotificationReceivedEventHandler NotificationReceived

Reconnected

Occurs when the OpcClient has successfully re-established a broken connection to the server.

C#

public event EventHandler Reconnected

Reconnecting

Occurs when the OpcClient is about to re-establish a broken connection to the server.

C#

public event EventHandler Reconnecting

StateChanged

Occurs when ever the State property has been changed to a different value.

C#

public event EventHandler<OpcClientStateChangedEventArgs> StateChanged

SubscriptionsChanged

C#

public event EventHandler SubscriptionsChanged

ApplicationName

Gets or sets the name of the client application.

C#

public override string ApplicationName { get; set; }


Property Value

String

The name of the application. The default value is “OPC Application” in case there is no entry assembly available; otherwise the value of the AssemblyTitleAttribute of the entry assembly.



Remarks

The name does not have to be unique. In case there is no SessionName used the ApplicationName is used as the session name instead. The value of this property is also used as the Cryptography.X509Certificates.X509Certificate2.SubjectName of the application certificate whenever an application certificate is to be created/looked-up (from the application certificates store).

Configuration

Gets or sets an instance of the OpcApplicationConfiguration class which is used as a low-level representation of the code/file based client application configuration.

C#

[CLSCompliant(false)]
public override OpcApplicationConfiguration Configuration { get; set; }


Property Value

OpcApplicationConfiguration

An instance of the OpcApplicationConfiguration class configured with the client specific setup to use. An assignment of a null reference (Nothing in Visual Basic) will lead to the creation of a new instance of the OpcApplicationConfiguration class with all defaults typically used by client applications.



Remarks

A file based OpcApplicationConfiguration needs to be loaded manually either using a specific config-section in its App.config (see LoadClientConfig(String)) or using a custom file using LoadClientConfigFile(String). A low-level code based client configuration can be directly performed using an instance of the OpcApplicationConfiguration like the instance provided by this property.

DefaultSubscription

C#

public OpcSubscription DefaultSubscription { get; set; }


Property Value

OpcSubscription

DisconnectTimeout

Gets or sets the wait time before terminating the attempt to shut-down an activated session.

C#

public int DisconnectTimeout { get; set; }


Property Value

Int32

The time in milliseconds to wait before terminating the attempt to shut-down an activated session.



Exceptions

ArgumentOutOfRangeException

The value is less than zero.



Remarks

The default value of this property is DefaultDisconnectTimeout.

KeepAlive

C#

public OpcClientKeepAlive KeepAlive { get; }


Property Value

OpcClientKeepAlive

Locales

Gets a collection of locales supported/used by the client.

C#

public OpcLocaleCollection Locales { get; }


Property Value

OpcLocaleCollection

An instance of the OpcLocaleCollection which can be used to setup the supported/used locales. While each entry is a pure string representation of the locales supported/used it is important to use the same notation of the values provided by CultureInfo.Name (e.g. 'en' for english locales or 'de' for german locales, …). Leave the collection provided empty to use the servers default locale.

NodeSet

Gets or sets the OpcNodeSet which is offered by the server the client is operating on. The OpcClient uses the information in the node set to discover nodes, references and types “offline” (without the need to frequently query the server for the necessary information).

C#

public OpcNodeSet NodeSet { get; set; }


Property Value

OpcNodeSet

An instance of the OpcNodeSet class which offers information about the nodes, references and types declared and used by the server the client is operating on. If specified the client can reduce the amount of data requests and performs much faster. In case there is no OpcNodeSet specified a null reference (Nothing in Visual Basic).

OperationTimeout

Gets or sets the wait time before terminating an operation being processed by the server.

C#

public int OperationTimeout { get; set; }


Property Value

Int32

The time in milliseconds to wait before terminating an operation being processed by the server.



Remarks

The default value of this property is DefaultOperationTimeout.

ReconnectTimeout

Gets or sets the wait time before terminating the attempt to reconnect to a halted session. This does therefore also represent the time between reconnect attempts.

C#

public int ReconnectTimeout { get; set; }


Property Value

Int32

The time in milliseconds to wait before terminating the attempt to reconnect to a halted session. A value equals zero indicates that there is no reconnect attempt performed.



Exceptions

ArgumentOutOfRangeException

The value is less than zero.



Remarks

The default value of this property is DefaultReconnectTimeout.

ServerAddress

Gets or sets the Uri of the OPC UA server to operate on.

C#

public Uri ServerAddress { get; set; }


Property Value

Uri

An instance of the Uri class which provides the necessary resource information to establish a connection to the server to operate on.



Exceptions

ArgumentNullException

The value is a null reference (Nothing in Visual Basic).

ServerInterfaces

Gets a collection of OPC Classic interfaces supported by the server and used by the client. The general available interfaces are listed in the OpcClassicInterfaces class.

C#

public OpcClassicInterfaceCollection ServerInterfaces { get; }


Property Value

OpcClassicInterfaceCollection

An instance of the OpcClassicInterfaceCollection items are used when accessing an OPC Classic server.



Remarks

Preselecting the interfaces provided by a server will significantly improve the performance when connecting to an OPC Classic server, because of the supported interfaces will then not queried first via OPC Classic discovery.

Services

Gets the OpcClientServices instance which provides direct access to the different OPC UA services used/provided by the OpcClient.

C#

public OpcClientServices Services { get; }


Property Value

OpcClientServices

An instance of the OpcClientServices class which can be used to directly interact with the different services or to perform very low-level configurations to control their behavior.

SessionName

Gets or sets the name to use for sessions to identify a session of this client.

C#

public string SessionName { get; set; }


Property Value

String

The name to use for the next session created and activated through this client.

SessionTimeout

Gets or sets the wait time before an active session is handled as expired.

C#

public int SessionTimeout { get; set; }


Property Value

Int32

The time in milliseconds to wait before an active session is handled as expired.



Exceptions

ArgumentOutOfRangeException

The value is less than zero.



Remarks

The default value of this property is DefaultSessionTimeout.

State

Gets a value that indicates the current state of the client regarding its channel used to communicate with the endpoint defined by ServerAddress and EndpointPolicy setup via Security.

C#

public OpcClientState State { get; }


Property Value

OpcClientState

One of the members defined by the OpcClientState enumeration. Which specifies the current state of the client. The initial value of this property is Created. Any subsequent transition of the value of this property will never change the value of this property back to its initial value (= Created).



Remarks

Depending on the current state different actions are either allowed, disallowed or functional on the current OpcClient instance.

Subscriptions

C#

public OpcSubscriptionReadOnlyCollection Subscriptions { get; }


Property Value

OpcSubscriptionReadOnlyCollection

SystemContext

C#

public OpcContext SystemContext { get; }


Property Value

OpcContext

UseBreakDetection

Gets or sets a value indicating whether a connection break detection is to be used.

C#

public bool UseBreakDetection { get; set; }


Property Value

Boolean

The value true if connection breaks have to be detected; otherwise the value false.



Remarks

The default value of this property is true.

UsedEndpoint

Gets the OpcEndpointDescription of the servers provided endpoints which has been selected by the client to connect to the server.

C#

public OpcEndpointDescription UsedEndpoint { get; }


Property Value

OpcEndpointDescription

An instance of the OpcEndpointDescription representing the metadata of the endpoint of the endpoint to which the client has established a connection.

UseDynamic

Gets or sets a value indicating whether the current OpcClient shall use generic types to represent OPC UA server defined custom types. To do so the client will determine the necessary type information from the server directly after a connection to the server has been established using Connect.

C#

public bool UseDynamic { get; set; }


Property Value

Boolean

The value true if the current OpcClient shall use generic types constructed from the type information offered by the server; otherwise the value false. The default value is determined by the UseDynamic property.

AddNode(OpcAddNode)

Adds a new node into the address space hierarchy using the command specified.

C#

public OpcAddNodeResult AddNode(OpcAddNode command)


Parameters

command OpcAddNode

The OpcAddNode instance to process.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the command specified; together with information about the outcome of the processed command.



Exceptions

ArgumentNullException

The command is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the command specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the command specified are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddNodes(IEnumerable<OpcAddNode>)

Adds one or more nodes into the address space hierarchy using the commands specified.

C#

public OpcAddNodeResultCollection AddNodes(IEnumerable<OpcAddNode> commands)


Parameters

commands IEnumerable<OpcAddNode>

A sequence of OpcAddNode instances to process.


Returns

OpcAddNodeResultCollection

An instance of the OpcAddNodeResultCollection class which contains the node identifiers used or created for the nodes added through the commands specified; together with information about the outcome of each processed command.



Exceptions

ArgumentNullException

The commands sequence or one of its items is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the commands specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the commands specified are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddNodes(OpcAddNode[])

Adds one or more nodes into the address space hierarchy using the commands specified.

C#

public OpcAddNodeResultCollection AddNodes(params OpcAddNode[] commands)


Parameters

commands OpcAddNode[]

An array of OpcAddNode instances to process.


Returns

OpcAddNodeResultCollection

An instance of the OpcAddNodeResultCollection class which contains the node identifiers used or created for the nodes added through the commands specified; together with information about the outcome of each processed command.



Exceptions

ArgumentNullException

The commands sequence or one of its items is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the commands specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the commands specified are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName)

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name defined. The according OpcNodeId to identify and access the new node is determined by the service. The new node will be a child of the ObjectsFolder node using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The name is equals Null.

ArgumentNullException

The name is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName, OpcAddInstanceNode[])

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name defined. The according OpcNodeId to identify and access the new node is determined by the service. The new node will be a child of the ObjectsFolder node using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name, params OpcAddInstanceNode[] children)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.

children OpcAddInstanceNode[]

The initial child nodes of the node to add.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The name is equals Null.

ArgumentNullException

The name is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName, OpcNodeId)

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the ObjectsFolder node using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name, OpcNodeId nodeId)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The name is equals Null.

ArgumentNullException

The name or nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName, OpcNodeId, OpcAddInstanceNode[])

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the ObjectsFolder node using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name, OpcNodeId nodeId, params OpcAddInstanceNode[] children)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

children OpcAddInstanceNode[]

The initial child nodes of the node to add.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The name is equals Null.

ArgumentNullException

The name or nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName, OpcNodeId, OpcNodeId)

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using HasComponent as the type of reference.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId or parentNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName, OpcNodeId, OpcNodeId, OpcAddInstanceNode[])

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, params OpcAddInstanceNode[] children)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using HasComponent as the type of reference.

children OpcAddInstanceNode[]

The initial child nodes of the node to add.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId or parentNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName, OpcNodeId, OpcNodeId, OpcNodeId)

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using the type of reference identified by the referenceTypeId specified.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, OpcNodeId referenceTypeId)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using the type of reference identified by referenceTypeId.

referenceTypeId OpcNodeId

The OpcNodeId which identifies the type of reference to use for the new node and the existing parent node identified by parentNodeId.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId or referenceTypeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId, parentNodeId or referenceTypeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName, OpcNodeId, OpcNodeId, OpcNodeId, OpcAddInstanceNode[])

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using the type of reference identified by the referenceTypeId specified.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, OpcNodeId referenceTypeId, params OpcAddInstanceNode[] children)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using the type of reference identified by referenceTypeId.

referenceTypeId OpcNodeId

The OpcNodeId which identifies the type of reference to use for the new node and the existing parent node identified by parentNodeId.

children OpcAddInstanceNode[]

The initial child nodes of the node to add.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId or referenceTypeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId, parentNodeId or referenceTypeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName, OpcNodeId, OpcNodeId, OpcReferenceType)

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using the referenceType specified as the type of reference.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, OpcReferenceType referenceType)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using HasComponent as the type of reference.

referenceType OpcReferenceType

One of the members defined by the OpcReferenceType enumeration to use to setup the reference between the new node and the existing parent node identified by parentNodeId.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId or parentNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddObjectNode(OpcObjectType, OpcName, OpcNodeId, OpcNodeId, OpcReferenceType, OpcAddInstanceNode[])

Adds a new object node into the address space hierarchy using the specified type of object node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using the referenceType specified as the type of reference.

C#

public OpcAddNodeResult AddObjectNode(OpcObjectType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, OpcReferenceType referenceType, params OpcAddInstanceNode[] children)


Parameters

type OpcObjectType

One of the members defined by the OpcObjectType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new object node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using HasComponent as the type of reference.

referenceType OpcReferenceType

One of the members defined by the OpcReferenceType enumeration to use to setup the reference between the new node and the existing parent node identified by parentNodeId.

children OpcAddInstanceNode[]

The initial child nodes of the node to add.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId or parentNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddReference(OpcAddReference)

Adds a new reference to existing nodes in the address space hierarchy using the command specified.

C#

public OpcStatus AddReference(OpcAddReference command)


Parameters

command OpcAddReference

The OpcAddReference instance to process.


Returns

OpcStatus

An instance of the OpcStatus class which contains the information about the outcome of the processed command.



Exceptions

ArgumentNullException

The command is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the command specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the command specified are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly The reference type is not valid for a reference to a remote server.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed The reference type between the nodes is already defined.
BadInvalidSelfReference The server does not allow this type of self reference on this node.

AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory)

Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other. The new reference will be a ParentToChild relation using Organizes as the type of reference.

C#

public OpcStatus AddReference(OpcNodeId nodeId, OpcNodeId targetNodeId, OpcNodeCategory targetNodeCategory)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the source node can be identified and accessed. This identifier refers to the 'child' node.

targetNodeId OpcNodeId

The OpcNodeId through that the target node can be identified and accessed. This identifier referes to the 'parent' node.

targetNodeCategory OpcNodeCategory

One of the members defined by the OpcNodeCategory enumeration which is used by the server to validate that the reference to be added matches the OpcNodeCategory of the target node identified by the targetNodeId.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId or targetNodeId is equals Null.

ArgumentNullException

The nodeId or targetNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly The reference type is not valid for a reference to a remote server.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed The reference type between the nodes is already defined.
BadInvalidSelfReference The server does not allow this type of self reference on this node.

AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory, OpcReferenceDirection)

Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other using the direction specified. The new reference will use the relation defined by direction using the Organizes as the type of reference.

C#

public OpcStatus AddReference(OpcNodeId nodeId, OpcNodeId targetNodeId, OpcNodeCategory targetNodeCategory, OpcReferenceDirection direction)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the source node can be identified and accessed.

targetNodeId OpcNodeId

The OpcNodeId through that the target node can be identified and accessed.

targetNodeCategory OpcNodeCategory

One of the members defined by the OpcNodeCategory enumeration which is used by the server to validate that the reference to be added matches the OpcNodeCategory of the target node identified by the targetNodeId.

direction OpcReferenceDirection

One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference will construct.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId or targetNodeId is equals Null.

ArgumentNullException

The nodeId or targetNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly The reference type is not valid for a reference to a remote server.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed The reference type between the nodes is already defined.
BadInvalidSelfReference The server does not allow this type of self reference on this node.

AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory, OpcReferenceDirection, OpcNodeId)

Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other using the direction specified. The new reference will use the relation defined by direction using the type of reference identified by the referenceTypeId specified.

C#

public OpcStatus AddReference(OpcNodeId nodeId, OpcNodeId targetNodeId, OpcNodeCategory targetNodeCategory, OpcReferenceDirection direction, OpcNodeId referenceTypeId)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the source node can be identified and accessed.

targetNodeId OpcNodeId

The OpcNodeId through that the target node can be identified and accessed.

targetNodeCategory OpcNodeCategory

One of the members defined by the OpcNodeCategory enumeration which is used by the server to validate that the reference to be added matches the OpcNodeCategory of the target node identified by the targetNodeId.

direction OpcReferenceDirection

One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference will construct.

referenceTypeId OpcNodeId

The OpcNodeId which identifies the type of reference to use to setup the reference between the source and the target node identified by the nodeId and the targetNodeId.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId, targetNodeId or referenceTypeId is equals Null.

ArgumentNullException

The nodeId, targetNodeId or referenceTypeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly The reference type is not valid for a reference to a remote server.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed The reference type between the nodes is already defined.
BadInvalidSelfReference The server does not allow this type of self reference on this node.

AddReference(OpcNodeId, OpcNodeId, OpcNodeCategory, OpcReferenceDirection, OpcReferenceType)

Adds a new reference to existing nodes in the address space hierarchy using the identifiers of the nodes which shall reference each other using the direction specified. The new reference will use the relation defined by direction using the referenceType specified as the type of reference.

C#

public OpcStatus AddReference(OpcNodeId nodeId, OpcNodeId targetNodeId, OpcNodeCategory targetNodeCategory, OpcReferenceDirection direction, OpcReferenceType referenceType)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the source node can be identified and accessed.

targetNodeId OpcNodeId

The OpcNodeId through that the target node can be identified and accessed.

targetNodeCategory OpcNodeCategory

One of the members defined by the OpcNodeCategory enumeration which is used by the server to validate that the reference to be added matches the OpcNodeCategory of the target node identified by the targetNodeId.

direction OpcReferenceDirection

One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation the reference will construct.

referenceType OpcReferenceType

One of the members defined by the OpcReferenceType enumeration to use to setup the reference between the source and the target node identified by the nodeId and the targetNodeId.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId or targetNodeId is equals Null.

ArgumentNullException

The nodeId or targetNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly The reference type is not valid for a reference to a remote server.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed The reference type between the nodes is already defined.
BadInvalidSelfReference The server does not allow this type of self reference on this node.

AddReferences(IEnumerable<OpcAddReference>)

Adds one or more references to existing nodes in the address space hierarchy using the commands specified.

C#

public OpcStatusCollection AddReferences(IEnumerable<OpcAddReference> commands)


Parameters

commands IEnumerable<OpcAddReference>

A sequence of OpcAddReference instances to process.


Returns

OpcStatusCollection

An instance of the OpcStatusCollection class which contains the information about the outcome of each processed command.



Exceptions

ArgumentNullException

The commands sequence or one of its items is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add reference service is currently not supported, especially using the commands specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the commands specified are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly The reference type is not valid for a reference to a remote server.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed The reference type between the nodes is already defined.
BadInvalidSelfReference The server does not allow this type of self reference on this node.

AddReferences(OpcAddReference[])

Adds one or more references to existing nodes in the address space hierarchy using the commands specified.

C#

public OpcStatusCollection AddReferences(params OpcAddReference[] commands)


Parameters

commands OpcAddReference[]

An array of OpcAddReference instances to process.


Returns

OpcStatusCollection

An instance of the OpcStatusCollection class which contains the information about the outcome of each processed command.



Exceptions

ArgumentNullException

The commands sequence or one of its items is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add reference service is currently not supported, especially using the commands specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the commands specified are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerUriInvalid For more details see BadServerUriInvalid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model on this server.
BadReferenceLocalOnly The reference type is not valid for a reference to a remote server.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadDuplicateReferenceNotAllowed The reference type between the nodes is already defined.
BadInvalidSelfReference The server does not allow this type of self reference on this node.

AddVariableNode(OpcVariableType, OpcName)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name defined. The according OpcNodeId to identify and access the new node is determined by the service. The new node will be a child of the ObjectsFolder node using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The name is equals Null.

ArgumentNullException

The name is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddVariableNode(OpcVariableType, OpcName, Object)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name defined. The according OpcNodeId to identify and access the new node is determined by the service. The new node will be a child of the ObjectsFolder node using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name, object value)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.

value Object

The initial value of the new variable node.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The name is equals Null.

ArgumentNullException

The name is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddVariableNode(OpcVariableType, OpcName, OpcNodeId)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the ObjectsFolder node using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name, OpcNodeId nodeId)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The name is equals Null.

ArgumentNullException

The name or nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddVariableNode(OpcVariableType, OpcName, OpcNodeId, Object)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the ObjectsFolder node using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name, OpcNodeId nodeId, object value)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

value Object

The initial value of the new variable node.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The name is equals Null.

ArgumentNullException

The name or nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddVariableNode(OpcVariableType, OpcName, OpcNodeId, OpcNodeId)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using HasComponent as the type of reference.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId or parentNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddVariableNode(OpcVariableType, OpcName, OpcNodeId, OpcNodeId, Object)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using HasComponent as the type of reference.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, object value)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using HasComponent as the type of reference.

value Object

The initial value of the new variable node.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId or parentNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddVariableNode(OpcVariableType, OpcName, OpcNodeId, OpcNodeId, OpcNodeId)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using the type of reference identified by the referenceTypeId specified.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, OpcNodeId referenceTypeId)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using the type of reference identified by referenceTypeId.

referenceTypeId OpcNodeId

The OpcNodeId which identifies the type of reference to use for the new node and the existing parent node identified by parentNodeId.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId or referenceTypeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId, parentNodeId or referenceTypeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddVariableNode(OpcVariableType, OpcName, OpcNodeId, OpcNodeId, OpcNodeId, Object)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using the type of reference identified by the referenceTypeId specified.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, OpcNodeId referenceTypeId, object value)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using the type of reference identified by referenceTypeId.

referenceTypeId OpcNodeId

The OpcNodeId which identifies the type of reference to use for the new node and the existing parent node identified by parentNodeId.

value Object

The initial value of the new variable node.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId or referenceTypeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId, parentNodeId or referenceTypeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddVariableNode(OpcVariableType, OpcName, OpcNodeId, OpcNodeId, OpcReferenceType)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using the referenceType specified as the type of reference.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, OpcReferenceType referenceType)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using HasComponent as the type of reference.

referenceType OpcReferenceType

One of the members defined by the OpcReferenceType enumeration to use to setup the reference between the new node and the existing parent node identified by parentNodeId.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId or parentNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

AddVariableNode(OpcVariableType, OpcName, OpcNodeId, OpcNodeId, OpcReferenceType, Object)

Adds a new variable node into the address space hierarchy using the specified type of variable node to add, which shall be accessible by the name and nodeId defined. The new node will be a child of the node identified by parentNodeId using the referenceType specified as the type of reference.

C#

public OpcAddNodeResult AddVariableNode(OpcVariableType type, OpcName name, OpcNodeId nodeId, OpcNodeId parentNodeId, OpcReferenceType referenceType, object value)


Parameters

type OpcVariableType

One of the members defined by the OpcVariableType enumeration which identifies the predefined underlying type definition the new node will represent an instance of.

name OpcName

The OpcName through that the new variable node can be accessed.

nodeId OpcNodeId

The OpcNodeId through that the new node can be identified and accessed. In case there Null is specified the server will determine the according OpcNodeId by its own.

parentNodeId OpcNodeId

The OpcNodeId of the parent node to reference using HasComponent as the type of reference.

referenceType OpcReferenceType

One of the members defined by the OpcReferenceType enumeration to use to setup the reference between the new node and the existing parent node identified by parentNodeId.

value Object

The initial value of the new variable node.


Returns

OpcAddNodeResult

An instance of the OpcAddNodeResult class which contains the node identifier used or created for the node added through the the call to the add nodes service; together with information about the outcome of the processed service invocation.



Exceptions

ArgumentException

The parentNodeId is equals Null or name is equals Null.

ArgumentNullException

The name, nodeId or parentNodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadParentNodeIdInvalid The parent node id does not refer to a valid node.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadReferenceNotAllowed The reference could not be created because it violates constraints imposed by the data model.
BadNodeIdRejected The requested node id is already used by another node.
BadNodeClassInvalid For more details see BadNodeClassInvalid.
BadBrowseNameInvalid For more details see BadBrowseNameInvalid.
BadBrowseNameDuplicated The browse name is not unique among nodes that share the same relationship with the parent.
BadNodeAttributesInvalid The node attributes are not valid for the node class.
BadTypeDefinitionInvalid For more details see BadTypeDefinitionInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.

BrowseNode(OpcBrowseNode)

C#

public OpcNodeInfo BrowseNode(OpcBrowseNode command)


Parameters

command OpcBrowseNode



Returns

OpcNodeInfo



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


BrowseNode(OpcNodeId)

C#

public OpcNodeInfo BrowseNode(OpcNodeId nodeId)


Parameters

nodeId OpcNodeId



Returns

OpcNodeInfo



Exceptions

ArgumentNullException


InvalidOperationException


ObjectDisposedException


BrowseNode(OpcNodeId, IEnumerable<OpcReferenceType>)

C#

public OpcNodeInfo BrowseNode(OpcNodeId nodeId, IEnumerable<OpcReferenceType> referenceTypes)


Parameters

nodeId OpcNodeId


referenceTypes IEnumerable<OpcReferenceType>



Returns

OpcNodeInfo



Exceptions

ArgumentNullException


InvalidOperationException


ObjectDisposedException


BrowseNode(OpcNodeId, OpcReferenceType[])

C#

public OpcNodeInfo BrowseNode(OpcNodeId nodeId, params OpcReferenceType[] referenceTypes)


Parameters

nodeId OpcNodeId


referenceTypes OpcReferenceType[]



Returns

OpcNodeInfo



Exceptions

ArgumentNullException


InvalidOperationException


ObjectDisposedException


BrowseNode(OpcViewDescription, OpcNodeId)

C#

public OpcNodeInfo BrowseNode(OpcViewDescription view, OpcNodeId nodeId)


Parameters

view OpcViewDescription


nodeId OpcNodeId



Returns

OpcNodeInfo



Exceptions

ArgumentNullException


InvalidOperationException


ObjectDisposedException


BrowseNode(OpcViewDescription, OpcNodeId, IEnumerable<OpcReferenceType>)

C#

public OpcNodeInfo BrowseNode(OpcViewDescription view, OpcNodeId nodeId, IEnumerable<OpcReferenceType> referenceTypes)


Parameters

view OpcViewDescription


nodeId OpcNodeId


referenceTypes IEnumerable<OpcReferenceType>



Returns

OpcNodeInfo



Exceptions

ArgumentNullException


InvalidOperationException


ObjectDisposedException


BrowseNode(OpcViewDescription, OpcNodeId, OpcReferenceType[])

C#

public OpcNodeInfo BrowseNode(OpcViewDescription view, OpcNodeId nodeId, params OpcReferenceType[] referenceTypes)


Parameters

view OpcViewDescription


nodeId OpcNodeId


referenceTypes OpcReferenceType[]



Returns

OpcNodeInfo



Exceptions

ArgumentNullException


InvalidOperationException


ObjectDisposedException


BrowseNodeIds(BrowsePathCollection)

C#

public IEnumerable<OpcNodeId> BrowseNodeIds(BrowsePathCollection pathsToTranslate)


Parameters

pathsToTranslate BrowsePathCollection



Returns

IEnumerable<OpcNodeId>

BrowseNodes(IEnumerable<OpcBrowseNode>)

C#

public IEnumerable<OpcNodeInfo> BrowseNodes(IEnumerable<OpcBrowseNode> commands)


Parameters

commands IEnumerable<OpcBrowseNode>



Returns

IEnumerable<OpcNodeInfo>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


BrowseNodes(OpcBrowseNode[])

C#

public IEnumerable<OpcNodeInfo> BrowseNodes(params OpcBrowseNode[] commands)


Parameters

commands OpcBrowseNode[]



Returns

IEnumerable<OpcNodeInfo>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CallAction(OpcNodeId, OpcNodeId)

C#

public void CallAction(OpcNodeId objectId, OpcNodeId methodId)


Parameters

objectId OpcNodeId


methodId OpcNodeId


CallAction<T>(OpcNodeId, OpcNodeId, T)

C#

public void CallAction<T>(OpcNodeId objectId, OpcNodeId methodId, T parameter)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter T


CallAction<T1, T2, T3, T4, T5, T6, T7, T8>(OpcNodeId, OpcNodeId, T1, T2, T3, T4, T5, T6, T7, T8)

C#

public void CallAction<T1, T2, T3, T4, T5, T6, T7, T8>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4, T5 parameter5, T6 parameter6, T7 parameter7, T8 parameter8)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4


parameter5 5


parameter6 6


parameter7 7


parameter8 8


CallAction<T1, T2, T3, T4, T5, T6, T7>(OpcNodeId, OpcNodeId, T1, T2, T3, T4, T5, T6, T7)

C#

public void CallAction<T1, T2, T3, T4, T5, T6, T7>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4, T5 parameter5, T6 parameter6, T7 parameter7)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4


parameter5 5


parameter6 6


parameter7 7


CallAction<T1, T2, T3, T4, T5, T6>(OpcNodeId, OpcNodeId, T1, T2, T3, T4, T5, T6)

C#

public void CallAction<T1, T2, T3, T4, T5, T6>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4, T5 parameter5, T6 parameter6)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4


parameter5 5


parameter6 6


CallAction<T1, T2, T3, T4, T5>(OpcNodeId, OpcNodeId, T1, T2, T3, T4, T5)

C#

public void CallAction<T1, T2, T3, T4, T5>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4, T5 parameter5)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4


parameter5 5


CallAction<T1, T2, T3, T4>(OpcNodeId, OpcNodeId, T1, T2, T3, T4)

C#

public void CallAction<T1, T2, T3, T4>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4


CallAction<T1, T2, T3>(OpcNodeId, OpcNodeId, T1, T2, T3)

C#

public void CallAction<T1, T2, T3>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


CallAction<T1, T2>(OpcNodeId, OpcNodeId, T1, T2)

C#

public void CallAction<T1, T2>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


CallFunc<T, TResult>(OpcNodeId, OpcNodeId, T)

C#

public TResult CallFunc<T, TResult>(OpcNodeId objectId, OpcNodeId methodId, T parameter)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter T



Returns

t

CallFunc<T1, T2, T3, T4, T5, T6, T7, T8, TResult>(OpcNodeId, OpcNodeId, T1, T2, T3, T4, T5, T6, T7, T8)

C#

public TResult CallFunc<T1, T2, T3, T4, T5, T6, T7, T8, TResult>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4, T5 parameter5, T6 parameter6, T7 parameter7, T8 parameter8)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4


parameter5 5


parameter6 6


parameter7 7


parameter8 8



Returns

t

CallFunc<T1, T2, T3, T4, T5, T6, T7, TResult>(OpcNodeId, OpcNodeId, T1, T2, T3, T4, T5, T6, T7)

C#

public TResult CallFunc<T1, T2, T3, T4, T5, T6, T7, TResult>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4, T5 parameter5, T6 parameter6, T7 parameter7)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4


parameter5 5


parameter6 6


parameter7 7



Returns

t

CallFunc<T1, T2, T3, T4, T5, T6, TResult>(OpcNodeId, OpcNodeId, T1, T2, T3, T4, T5, T6)

C#

public TResult CallFunc<T1, T2, T3, T4, T5, T6, TResult>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4, T5 parameter5, T6 parameter6)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4


parameter5 5


parameter6 6



Returns

t

CallFunc<T1, T2, T3, T4, T5, TResult>(OpcNodeId, OpcNodeId, T1, T2, T3, T4, T5)

C#

public TResult CallFunc<T1, T2, T3, T4, T5, TResult>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4, T5 parameter5)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4


parameter5 5



Returns

t

CallFunc<T1, T2, T3, T4, TResult>(OpcNodeId, OpcNodeId, T1, T2, T3, T4)

C#

public TResult CallFunc<T1, T2, T3, T4, TResult>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3, T4 parameter4)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3


parameter4 4



Returns

t

CallFunc<T1, T2, T3, TResult>(OpcNodeId, OpcNodeId, T1, T2, T3)

C#

public TResult CallFunc<T1, T2, T3, TResult>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2, T3 parameter3)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2


parameter3 3



Returns

t

CallFunc<T1, T2, TResult>(OpcNodeId, OpcNodeId, T1, T2)

C#

public TResult CallFunc<T1, T2, TResult>(OpcNodeId objectId, OpcNodeId methodId, T1 parameter1, T2 parameter2)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameter1 1


parameter2 2



Returns

t

CallFunc<TResult>(OpcNodeId, OpcNodeId)

C#

public TResult CallFunc<TResult>(OpcNodeId objectId, OpcNodeId methodId)


Parameters

objectId OpcNodeId


methodId OpcNodeId



Returns

t

CallMethod(OpcCallMethod)

C#

public object[] CallMethod(OpcCallMethod command)


Parameters

command OpcCallMethod



Returns

Object[]



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CallMethod(OpcNodeId, OpcNodeId)

C#

public object[] CallMethod(OpcNodeId objectId, OpcNodeId methodId)


Parameters

objectId OpcNodeId


methodId OpcNodeId



Returns

Object[]



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CallMethod(OpcNodeId, OpcNodeId, IEnumerable<Object>)

C#

public object[] CallMethod(OpcNodeId objectId, OpcNodeId methodId, IEnumerable<object> parameters)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameters IEnumerable<Object>



Returns

Object[]



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CallMethod(OpcNodeId, OpcNodeId, Object[])

C#

public object[] CallMethod(OpcNodeId objectId, OpcNodeId methodId, params object[] parameters)


Parameters

objectId OpcNodeId


methodId OpcNodeId


parameters Object[]



Returns

Object[]



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CallMethods(IEnumerable<OpcCallMethod>)

C#

public object[][] CallMethods(IEnumerable<OpcCallMethod> commands)


Parameters

commands IEnumerable<OpcCallMethod>



Returns

Object[][]



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CallMethods(OpcCallMethod[])

C#

public object[][] CallMethods(params OpcCallMethod[] commands)


Parameters

commands OpcCallMethod[]



Returns

Object[][]



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


Connect()

Establishes a connection to the server identified by the ServerAddress and creates/activates a new session to access the OPC UA services provided by the server.

C#

public void Connect()



Exceptions

InvalidOperationException

The ServerAddress is not specified. The value of ServerAddress is a null reference (Nothing in Visual Basic) or the method is currently not supported, because of the license has expired.

ObjectDisposedException

The object has been disposed of.

OpcException

This type of exception can have the following reasons: * BadSecureChannelClosed The secure channel has been closed. This can have the following reasons: * Reason A The client certificate is unknown or untrusted by the server. * Solution A Store the client certificate in the servers certificate store for trusted certificates. * Solution B Use a different endpoint with the OpcSecurityMode value None to connect to the server.

ConnectCore()

Performs all necessary tasks to establish a connection to the server identified by the ServerAddress and creates/activates a new session to access the OPC UA services provided by the server.

C#

protected virtual void ConnectCore()

CreateNodeHistory(Int32, IEnumerable<OpcValue>)

C#

public OpcStatusCollection CreateNodeHistory(int nodeId, IEnumerable<OpcValue> values)


Parameters

nodeId Int32


values IEnumerable<OpcValue>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(Int32, Int32, IEnumerable<OpcValue>)

C#

public OpcStatusCollection CreateNodeHistory(int nodeId, int namespaceIndex, IEnumerable<OpcValue> values)


Parameters

nodeId Int32


namespaceIndex Int32


values IEnumerable<OpcValue>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(Int32, Int32, OpcValue)

C#

public OpcStatus CreateNodeHistory(int nodeId, int namespaceIndex, OpcValue value)


Parameters

nodeId Int32


namespaceIndex Int32


value OpcValue



Returns

OpcStatus



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(Int32, OpcValue)

C#

public OpcStatus CreateNodeHistory(int nodeId, OpcValue value)


Parameters

nodeId Int32


value OpcValue



Returns

OpcStatus



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(Int32, OpcValue[])

C#

public OpcStatusCollection CreateNodeHistory(int nodeId, params OpcValue[] values)


Parameters

nodeId Int32


values OpcValue[]



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(OpcCreateNodeHistory)

C#

public OpcStatusCollection CreateNodeHistory(OpcCreateNodeHistory command)


Parameters

command OpcCreateNodeHistory



Returns

OpcStatusCollection



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(OpcNodeId, IEnumerable<OpcValue>)

C#

public OpcStatusCollection CreateNodeHistory(OpcNodeId nodeId, IEnumerable<OpcValue> values)


Parameters

nodeId OpcNodeId


values IEnumerable<OpcValue>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(OpcNodeId, OpcValue)

C#

public OpcStatus CreateNodeHistory(OpcNodeId nodeId, OpcValue value)


Parameters

nodeId OpcNodeId


value OpcValue



Returns

OpcStatus



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(OpcNodeId, OpcValue[])

C#

public OpcStatusCollection CreateNodeHistory(OpcNodeId nodeId, params OpcValue[] values)


Parameters

nodeId OpcNodeId


values OpcValue[]



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(String, IEnumerable<OpcValue>)

C#

public OpcStatusCollection CreateNodeHistory(string nodeId, IEnumerable<OpcValue> values)


Parameters

nodeId String


values IEnumerable<OpcValue>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(String, Int32, IEnumerable<OpcValue>)

C#

public OpcStatusCollection CreateNodeHistory(string nodeId, int namespaceIndex, IEnumerable<OpcValue> values)


Parameters

nodeId String


namespaceIndex Int32


values IEnumerable<OpcValue>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(String, Int32, OpcValue)

C#

public OpcStatus CreateNodeHistory(string nodeId, int namespaceIndex, OpcValue value)


Parameters

nodeId String


namespaceIndex Int32


value OpcValue



Returns

OpcStatus



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(String, Int32, OpcValue[])

C#

public OpcStatusCollection CreateNodeHistory(string nodeId, int namespaceIndex, params OpcValue[] values)


Parameters

nodeId String


namespaceIndex Int32


values OpcValue[]



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(String, OpcValue)

C#

public OpcStatus CreateNodeHistory(string nodeId, OpcValue value)


Parameters

nodeId String


value OpcValue



Returns

OpcStatus



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodeHistory(String, OpcValue[])

C#

public OpcStatusCollection CreateNodeHistory(string nodeId, params OpcValue[] values)


Parameters

nodeId String


values OpcValue[]



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodesHistory(IEnumerable<OpcCreateNodeHistory>)

C#

public IDictionary<OpcNodeId, OpcStatusCollection> CreateNodesHistory(IEnumerable<OpcCreateNodeHistory> commands)


Parameters

commands IEnumerable<OpcCreateNodeHistory>



Returns

IDictionary<OpcNodeId, OpcStatusCollection>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateNodesHistory(OpcCreateNodeHistory[])

C#

public IDictionary<OpcNodeId, OpcStatusCollection> CreateNodesHistory(params OpcCreateNodeHistory[] commands)


Parameters

commands OpcCreateNodeHistory[]



Returns

IDictionary<OpcNodeId, OpcStatusCollection>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


CreateSecurity()

Creates a new instance of the OpcClientSecurity class.

C#

protected override sealed OpcClientSecurity CreateSecurity()


Returns

OpcClientSecurity

A new instance of theOpcClientSecurity class.

CreateTransport()

Creates a new instance of the OpcTransport class.

C#

protected override sealed OpcTransport CreateTransport()


Returns

OpcTransport

A new instance of theOpcTransport class.

DeleteNode(OpcDeleteNode)

Deletes a node from the address space hierarchy using the command specified.

C#

public OpcStatus DeleteNode(OpcDeleteNode command)


Parameters

command OpcDeleteNode

The OpcDeleteNode instance to process.


Returns

OpcStatus

An instance of the OpcStatus class which contains the information about the outcome of the processed command.



Exceptions

ArgumentNullException

The command is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the command specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the command specified are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.
UncertainReferenceNotDeleted The server was not able to delete all target references.

DeleteNode(OpcNodeId)

Deletes a node from the address space hierarchy using the identifier of the node which shall be deleted including the references where the node acts as the source and as the target of the reference.

C#

public OpcStatus DeleteNode(OpcNodeId nodeId)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the node to delete can be identified and accessed.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId is equals Null.

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The delete node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.
UncertainReferenceNotDeleted The server was not able to delete all target references.

DeleteNode(OpcNodeId, Boolean)

Deletes a node from the address space hierarchy using the identifier of the node which shall be deleted including the references where the node acts as the source and optionally (see includeTargetReferences) as the target of the reference.

C#

public OpcStatus DeleteNode(OpcNodeId nodeId, bool includeTargetReferences)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the node to delete can be identified and accessed.

includeTargetReferences Boolean

A value indicating whether all references there the node being deleted acts as the target shall be deleted as well. The value true if all references using the node to delete as the target of the reference shall be deleted as well; otherwise the value false which indicates that only references there the node to delete acts as the source of the reference.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId is equals Null.

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The delete node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.
UncertainReferenceNotDeleted The server was not able to delete all target references.

DeleteNodeHistory(Int32)

C#

public OpcStatusCollection DeleteNodeHistory(int nodeId)


Parameters

nodeId Int32



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(Int32, Int32)

C#

public OpcStatusCollection DeleteNodeHistory(int nodeId, int namespaceIndex)


Parameters

nodeId Int32


namespaceIndex Int32



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(Int32, Int32, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(int nodeId, int namespaceIndex, DateTime? startTime)


Parameters

nodeId Int32


namespaceIndex Int32


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(Int32, Int32, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(int nodeId, int namespaceIndex, DateTime? startTime, DateTime? endTime)


Parameters

nodeId Int32


namespaceIndex Int32


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(Int32, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(int nodeId, DateTime? startTime)


Parameters

nodeId Int32


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(Int32, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(int nodeId, DateTime? startTime, DateTime? endTime)


Parameters

nodeId Int32


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(OpcDeleteNodeHistory)

C#

public OpcStatusCollection DeleteNodeHistory(OpcDeleteNodeHistory command)


Parameters

command OpcDeleteNodeHistory



Returns

OpcStatusCollection



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(OpcNodeId)

C#

public OpcStatusCollection DeleteNodeHistory(OpcNodeId nodeId)


Parameters

nodeId OpcNodeId



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(OpcNodeId, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(OpcNodeId nodeId, DateTime? startTime)


Parameters

nodeId OpcNodeId


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(OpcNodeId, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(OpcNodeId nodeId, DateTime? startTime, DateTime? endTime)


Parameters

nodeId OpcNodeId


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(String)

C#

public OpcStatusCollection DeleteNodeHistory(string nodeId)


Parameters

nodeId String



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(String, Int32)

C#

public OpcStatusCollection DeleteNodeHistory(string nodeId, int namespaceIndex)


Parameters

nodeId String


namespaceIndex Int32



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(String, Int32, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(string nodeId, int namespaceIndex, DateTime? startTime)


Parameters

nodeId String


namespaceIndex Int32


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(String, Int32, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(string nodeId, int namespaceIndex, DateTime? startTime, DateTime? endTime)


Parameters

nodeId String


namespaceIndex Int32


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(String, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(string nodeId, DateTime? startTime)


Parameters

nodeId String


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistory(String, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistory(string nodeId, DateTime? startTime, DateTime? endTime)


Parameters

nodeId String


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(Int32, DateTime)

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(int nodeId, DateTime time)


Parameters

nodeId Int32


time DateTime



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(Int32, DateTime[])

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(int nodeId, params DateTime[] times)


Parameters

nodeId Int32


times DateTime[]



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(Int32, IEnumerable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(int nodeId, IEnumerable<DateTime> times)


Parameters

nodeId Int32


times IEnumerable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(Int32, Int32, DateTime)

C#

public OpcStatus DeleteNodeHistoryAtTime(int nodeId, int namespaceIndex, DateTime time)


Parameters

nodeId Int32


namespaceIndex Int32


time DateTime



Returns

OpcStatus



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(Int32, Int32, DateTime[])

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(int nodeId, int namespaceIndex, params DateTime[] times)


Parameters

nodeId Int32


namespaceIndex Int32


times DateTime[]



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(Int32, Int32, IEnumerable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(int nodeId, int namespaceIndex, IEnumerable<DateTime> times)


Parameters

nodeId Int32


namespaceIndex Int32


times IEnumerable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(OpcDeleteNodeHistoryAtTime)

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(OpcDeleteNodeHistoryAtTime command)


Parameters

command OpcDeleteNodeHistoryAtTime



Returns

OpcStatusCollection



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(OpcNodeId, DateTime)

C#

public OpcStatus DeleteNodeHistoryAtTime(OpcNodeId nodeId, DateTime time)


Parameters

nodeId OpcNodeId


time DateTime



Returns

OpcStatus



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(OpcNodeId, DateTime[])

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(OpcNodeId nodeId, params DateTime[] times)


Parameters

nodeId OpcNodeId


times DateTime[]



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(OpcNodeId, IEnumerable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(OpcNodeId nodeId, IEnumerable<DateTime> times)


Parameters

nodeId OpcNodeId


times IEnumerable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(String, DateTime)

C#

public OpcStatus DeleteNodeHistoryAtTime(string nodeId, DateTime time)


Parameters

nodeId String


time DateTime



Returns

OpcStatus



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(String, DateTime[])

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(string nodeId, params DateTime[] times)


Parameters

nodeId String


times DateTime[]



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(String, IEnumerable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(string nodeId, IEnumerable<DateTime> times)


Parameters

nodeId String


times IEnumerable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(String, Int32, DateTime)

C#

public OpcStatus DeleteNodeHistoryAtTime(string nodeId, int namespaceIndex, DateTime time)


Parameters

nodeId String


namespaceIndex Int32


time DateTime



Returns

OpcStatus



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(String, Int32, DateTime[])

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(string nodeId, int namespaceIndex, params DateTime[] times)


Parameters

nodeId String


namespaceIndex Int32


times DateTime[]



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryAtTime(String, Int32, IEnumerable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryAtTime(string nodeId, int namespaceIndex, IEnumerable<DateTime> times)


Parameters

nodeId String


namespaceIndex Int32


times IEnumerable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(Int32)

C#

public OpcStatusCollection DeleteNodeHistoryModified(int nodeId)


Parameters

nodeId Int32



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(Int32, Int32)

C#

public OpcStatusCollection DeleteNodeHistoryModified(int nodeId, int namespaceIndex)


Parameters

nodeId Int32


namespaceIndex Int32



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(Int32, Int32, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(int nodeId, int namespaceIndex, DateTime? startTime)


Parameters

nodeId Int32


namespaceIndex Int32


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(Int32, Int32, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(int nodeId, int namespaceIndex, DateTime? startTime, DateTime? endTime)


Parameters

nodeId Int32


namespaceIndex Int32


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(Int32, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(int nodeId, DateTime? startTime)


Parameters

nodeId Int32


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(Int32, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(int nodeId, DateTime? startTime, DateTime? endTime)


Parameters

nodeId Int32


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(OpcDeleteNodeHistoryModified)

C#

public OpcStatusCollection DeleteNodeHistoryModified(OpcDeleteNodeHistoryModified command)


Parameters

command OpcDeleteNodeHistoryModified



Returns

OpcStatusCollection



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(OpcNodeId)

C#

public OpcStatusCollection DeleteNodeHistoryModified(OpcNodeId nodeId)


Parameters

nodeId OpcNodeId



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(OpcNodeId, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(OpcNodeId nodeId, DateTime? startTime)


Parameters

nodeId OpcNodeId


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(OpcNodeId, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(OpcNodeId nodeId, DateTime? startTime, DateTime? endTime)


Parameters

nodeId OpcNodeId


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(String)

C#

public OpcStatusCollection DeleteNodeHistoryModified(string nodeId)


Parameters

nodeId String



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(String, Int32)

C#

public OpcStatusCollection DeleteNodeHistoryModified(string nodeId, int namespaceIndex)


Parameters

nodeId String


namespaceIndex Int32



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(String, Int32, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(string nodeId, int namespaceIndex, DateTime? startTime)


Parameters

nodeId String


namespaceIndex Int32


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(String, Int32, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(string nodeId, int namespaceIndex, DateTime? startTime, DateTime? endTime)


Parameters

nodeId String


namespaceIndex Int32


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(String, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(string nodeId, DateTime? startTime)


Parameters

nodeId String


startTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodeHistoryModified(String, Nullable<DateTime>, Nullable<DateTime>)

C#

public OpcStatusCollection DeleteNodeHistoryModified(string nodeId, DateTime? startTime, DateTime? endTime)


Parameters

nodeId String


startTime Nullable<DateTime>


endTime Nullable<DateTime>



Returns

OpcStatusCollection



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodes(IEnumerable<OpcDeleteNode>)

Deletes one or more nodes from the address space hierarchy using the commands specified.

C#

public OpcStatusCollection DeleteNodes(IEnumerable<OpcDeleteNode> commands)


Parameters

commands IEnumerable<OpcDeleteNode>

A sequence of OpcDeleteNode instances to process.


Returns

OpcStatusCollection

An instance of the OpcStatusCollection class which contains the information about the outcome of each processed command.



Exceptions

ArgumentNullException

The commands sequence or one of its items is a null reference (Nothing in Visual Basic).

InvalidOperationException

The delete node service is currently not supported, especially using the commands specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the commands specified are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.
UncertainReferenceNotDeleted The server was not able to delete all target references.

DeleteNodes(IEnumerable<OpcNodeId>)

Deletes one or more nodes from the address space hierarchy using the identifiers of the nodes which shall be deleted including the references where the node acts as the source and as the target of the reference.

C#

public OpcStatusCollection DeleteNodes(IEnumerable<OpcNodeId> nodeIds)


Parameters

nodeIds IEnumerable<OpcNodeId>

A sequence of OpcNodeId instances through that the nodes to delete can be identified and accessed.


Returns

OpcStatusCollection



Exceptions

ArgumentException

One of the OpcNodeId instances in nodeIds is equals Null.

ArgumentNullException

The nodeIds is a null reference (Nothing in Visual Basic).

InvalidOperationException

The delete node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.
UncertainReferenceNotDeleted The server was not able to delete all target references.

DeleteNodes(OpcDeleteNode[])

Deletes one or more nodes from the address space hierarchy using the commands specified.

C#

public OpcStatusCollection DeleteNodes(params OpcDeleteNode[] commands)


Parameters

commands OpcDeleteNode[]

An array of OpcDeleteNode instances to process.


Returns

OpcStatusCollection

An instance of the OpcStatusCollection class which contains the information about the outcome of each processed command.



Exceptions

ArgumentNullException

The commands sequence or one of its items is a null reference (Nothing in Visual Basic).

InvalidOperationException

The delete node service is currently not supported, especially using the commands specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the commands specified are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.
UncertainReferenceNotDeleted The server was not able to delete all target references.

DeleteNodes(OpcNodeId[])

Deletes one or more nodes from the address space hierarchy using the identifiers of the nodes which shall be deleted including the references where the node acts as the source and as the target of the reference.

C#

public OpcStatusCollection DeleteNodes(params OpcNodeId[] nodeIds)


Parameters

nodeIds OpcNodeId[]

An array of OpcNodeId instances through that the nodes to delete can be identified and accessed.


Returns

OpcStatusCollection



Exceptions

ArgumentException

One of the OpcNodeId instances in nodeIds is equals Null.

ArgumentNullException

The nodeIds is a null reference (Nothing in Visual Basic).

InvalidOperationException

The delete node service is currently not supported, especially using the parameters specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.
UncertainReferenceNotDeleted The server was not able to delete all target references.

DeleteNodesHistory(IEnumerable<OpcDeleteNodeHistory>)

C#

public IDictionary<OpcNodeId, OpcStatusCollection> DeleteNodesHistory(IEnumerable<OpcDeleteNodeHistory> commands)


Parameters

commands IEnumerable<OpcDeleteNodeHistory>



Returns

IDictionary<OpcNodeId, OpcStatusCollection>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodesHistory(OpcDeleteNodeHistory[])

C#

public IDictionary<OpcNodeId, OpcStatusCollection> DeleteNodesHistory(params OpcDeleteNodeHistory[] commands)


Parameters

commands OpcDeleteNodeHistory[]



Returns

IDictionary<OpcNodeId, OpcStatusCollection>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodesHistoryAtTime(IEnumerable<OpcDeleteNodeHistoryAtTime>)

C#

public IDictionary<OpcNodeId, OpcStatusCollection> DeleteNodesHistoryAtTime(IEnumerable<OpcDeleteNodeHistoryAtTime> commands)


Parameters

commands IEnumerable<OpcDeleteNodeHistoryAtTime>



Returns

IDictionary<OpcNodeId, OpcStatusCollection>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodesHistoryAtTime(OpcDeleteNodeHistoryAtTime[])

C#

public IDictionary<OpcNodeId, OpcStatusCollection> DeleteNodesHistoryAtTime(params OpcDeleteNodeHistoryAtTime[] commands)


Parameters

commands OpcDeleteNodeHistoryAtTime[]



Returns

IDictionary<OpcNodeId, OpcStatusCollection>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodesHistoryModified(IEnumerable<OpcDeleteNodeHistoryModified>)

C#

public IDictionary<OpcNodeId, OpcStatusCollection> DeleteNodesHistoryModified(IEnumerable<OpcDeleteNodeHistoryModified> commands)


Parameters

commands IEnumerable<OpcDeleteNodeHistoryModified>



Returns

IDictionary<OpcNodeId, OpcStatusCollection>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteNodesHistoryModified(OpcDeleteNodeHistoryModified[])

C#

public IDictionary<OpcNodeId, OpcStatusCollection> DeleteNodesHistoryModified(params OpcDeleteNodeHistoryModified[] commands)


Parameters

commands OpcDeleteNodeHistoryModified[]



Returns

IDictionary<OpcNodeId, OpcStatusCollection>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


DeleteReference(OpcDeleteReference)

Deletes a reference of existing nodes in the address space hierarchy using the command specified.

C#

public OpcStatus DeleteReference(OpcDeleteReference command)


Parameters

command OpcDeleteReference

The OpcDeleteReference instance to process.


Returns

OpcStatus

An instance of the OpcStatus class which contains the information about the outcome of the processed command.



Exceptions

ArgumentNullException

The command is a null reference (Nothing in Visual Basic).

InvalidOperationException

The add node service is currently not supported, especially using the command specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the command specified are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid The server index is not valid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.

DeleteReference(OpcNodeId, OpcNodeId)

Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other. The relation is deleted in bidirectional direction using Organizes as the type of reference.

C#

public OpcStatus DeleteReference(OpcNodeId nodeId, OpcNodeId targetNodeId)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the source node can be identified and accessed.

targetNodeId OpcNodeId

The OpcNodeId through that the target node can be identified and accessed.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId or targetNodeId is equals Null.

ArgumentNullException

The nodeId or targetNodeId is a null reference (Nothing in Visual Basic).

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid The server index is not valid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.

DeleteReference(OpcNodeId, OpcNodeId, Nullable<OpcReferenceDirection>)

Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other using the direction specified. The reference to delete have to be of the relation defined by direction using the Organizes as the type of reference.

C#

public OpcStatus DeleteReference(OpcNodeId nodeId, OpcNodeId targetNodeId, OpcReferenceDirection? direction)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the source node can be identified and accessed.

targetNodeId OpcNodeId

The OpcNodeId through that the target node can be identified and accessed.

direction Nullable<OpcReferenceDirection>

One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation of reference to delete or a null reference (Nothing in Visual Basic) in case there the relation is to be deleted in bidirectional direction.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId or targetNodeId is equals Null.

ArgumentNullException

The nodeId or targetNodeId is a null reference (Nothing in Visual Basic).

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid The server index is not valid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.

DeleteReference(OpcNodeId, OpcNodeId, Nullable<OpcReferenceDirection>, OpcNodeId)

Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other using the direction specified. The reference to delete have to be of the relation defined by direction using the type of reference identified by the referenceTypeId specified.

C#

public OpcStatus DeleteReference(OpcNodeId nodeId, OpcNodeId targetNodeId, OpcReferenceDirection? direction, OpcNodeId referenceTypeId)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the source node can be identified and accessed.

targetNodeId OpcNodeId

The OpcNodeId through that the target node can be identified and accessed.

direction Nullable<OpcReferenceDirection>

One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation of reference to delete or a null reference (Nothing in Visual Basic) in case there the relation is to be deleted in bidirectional direction.

referenceTypeId OpcNodeId

The OpcNodeId which identifies the type of reference to use to setup the reference between the source and the target node identified by the nodeId and the targetNodeId.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId, targetNodeId or referenceTypeId is equals Null.

ArgumentNullException

The nodeId, targetNodeId or referenceTypeId is a null reference (Nothing in Visual Basic).

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid The server index is not valid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.

DeleteReference(OpcNodeId, OpcNodeId, Nullable<OpcReferenceDirection>, OpcReferenceType)

Deletes one or more references of existing nodes in the address space hierarchy using the identifiers of the nodes which shall not longer reference each other using the direction specified. The reference to delete have to be of the relation defined by direction using the referenceType specified as the type of reference.

C#

public OpcStatus DeleteReference(OpcNodeId nodeId, OpcNodeId targetNodeId, OpcReferenceDirection? direction, OpcReferenceType referenceType)


Parameters

nodeId OpcNodeId

The OpcNodeId through that the source node can be identified and accessed.

targetNodeId OpcNodeId

The OpcNodeId through that the target node can be identified and accessed.

direction Nullable<OpcReferenceDirection>

One of the members defined by the OpcReferenceDirection enumeration which defines the kind of relation of reference to delete or a null reference (Nothing in Visual Basic) in case there the relation is to be deleted in bidirectional direction.

referenceType OpcReferenceType

One of the members defined by the OpcReferenceType enumeration to use to setup the reference between the source and the target node identified by the nodeId and the targetNodeId.


Returns

OpcStatus



Exceptions

ArgumentException

The nodeId or targetNodeId is equals Null.

ArgumentNullException

The nodeId or targetNodeId is a null reference (Nothing in Visual Basic).

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the service invocation are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid The server index is not valid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.

DeleteReferences(IEnumerable<OpcDeleteReference>)

Deletes one or more references of existing nodes in the address space hierarchy using the commands specified.

C#

public OpcStatusCollection DeleteReferences(IEnumerable<OpcDeleteReference> commands)


Parameters

commands IEnumerable<OpcDeleteReference>

A sequence of OpcDeleteReference instances to process.


Returns

OpcStatusCollection

An instance of the OpcStatusCollection class which contains the information about the outcome of each processed command.



Exceptions

ArgumentNullException

The commands sequence or one of its items is a null reference (Nothing in Visual Basic).

InvalidOperationException

The delete reference service is currently not supported, especially using the commands specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the commands specified are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid The server index is not valid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.

DeleteReferences(OpcDeleteReference[])

Deletes one or more references of existing nodes in the address space hierarchy using the commands specified.

C#

public OpcStatusCollection DeleteReferences(params OpcDeleteReference[] commands)


Parameters

commands OpcDeleteReference[]

An array of OpcDeleteReference instances to process.


Returns

OpcStatusCollection

An instance of the OpcStatusCollection class which contains the information about the outcome of each processed command.



Exceptions

ArgumentNullException

The commands sequence or one of its items is a null reference (Nothing in Visual Basic).

InvalidOperationException

The delete reference service is currently not supported, especially using the commands specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.


Remarks

Known results for the commands specified are:

Status Description
BadSourceNodeIdInvalid For more details see BadSourceNodeIdInvalid.
BadReferenceTypeIdInvalid For more details see BadReferenceTypeIdInvalid.
BadServerIndexInvalid The server index is not valid.
BadTargetNodeIdInvalid For more details see BadTargetNodeIdInvalid.
BadUserAccessDenied For more details see BadUserAccessDenied.
BadNoDeleteRights For more details see BadNoDeleteRights.

DenyIfNotConnected()

Verifies whether the client is connected to the server.

C#

protected void DenyIfNotConnected()



Exceptions

OpcException

The client is not connected to the server.

Disconnect()

Closes an activated session and terminates the connection to the server.

C#

public void Disconnect()



Exceptions

InvalidOperationException

The method is currently not supported, because of the license has expired.

ObjectDisposedException

The object has been disposed of.

OpcException


DisconnectCore()

Performs all necessary tasks to close an activated session and to terminate the connection to the server.

C#

protected virtual void DisconnectCore()

Dispose(Boolean)

Releases the unmanaged resources used by the OpcClient and optionally releases the managed resources.

C#

protected override void Dispose(bool disposing)


Parameters

disposing Boolean

The value true to release both managed and unmanaged resources; otherwise the value false to release only unmanaged resources.

GetDataType(OpcEncoding)

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.

C#

public OpcDataTypeInfo GetDataType(OpcEncoding encoding)


Parameters

encoding OpcEncoding

The OpcEncoding which identifies the OpcDataTypeInfo to retrieve.


Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which is known under the encoding specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo which is associated with the encoding specified.



Exceptions

ArgumentNullException

The encoding is a null reference (Nothing in Visual Basic).

GetDataType(OpcName)

Retrieves the OpcDataTypeInfo object which is known under the name specified.

C#

public OpcDataTypeInfo GetDataType(OpcName name)


Parameters

name OpcName

The OpcName of the OpcDataTypeInfo object to retrieve.


Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).



Exceptions

ArgumentNullException

The name is a null reference (Nothing in Visual Basic).

GetDataType(OpcNodeId)

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.

C#

public OpcDataTypeInfo GetDataType(OpcNodeId typeId)


Parameters

typeId OpcNodeId

The OpcNodeId which identifies the OpcDataTypeInfo to retrieve.


Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo object which is associated with the typeId specified.



Exceptions

ArgumentNullException

The typeId is a null reference (Nothing in Visual Basic).

GetDataType(String)

Retrieves the OpcDataTypeInfo object which is known under the name specified.

C#

public OpcDataTypeInfo GetDataType(string name)


Parameters

name String

The String to use to identify the OpcDataTypeInfo object to retrieve.


Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).



Exceptions

ArgumentException

The name is equals Empty.

ArgumentNullException

The name is a null reference (Nothing in Visual Basic).

GetDataType(Type)

Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.

C#

public OpcDataTypeInfo GetDataType(Type underlyingType)


Parameters

underlyingType Type

The Type which implements the OpcDataTypeInfo to retrieve.


Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcDataTypeInfo object associated with the underlyingType specified.



Exceptions

ArgumentNullException

The underlyingType is a null reference (Nothing in Visual Basic).

GetDataType(XmlQualifiedName)

Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.

C#

public OpcDataTypeInfo GetDataType(XmlQualifiedName xmlName)


Parameters

xmlName XmlQualifiedName

The XmlQualifiedName of the OpcDataTypeInfo object to retrieve.


Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its XmlName is equals to the xmlName specified; otherwise a null reference (Nothing in Visual Basic).



Exceptions

ArgumentNullException

The xmlName is a null reference (Nothing in Visual Basic).

GetDataTypes()

Retrieves all OpcDataTypeInfo objects offered by the IOpcTypeProvider.

C#

public OpcDataTypeInfo[] GetDataTypes()


Returns

OpcDataTypeInfo[]

An array that contains all OpcDataTypeInfo objects that are offered by the IOpcTypeProvider.

GetDataTypeSystem()

Retrieves the system used to describe the data exchanged via OPC UA using the type of encoding configured by the client and supported by the endpdoint of the server connected to.

C#

public OpcDataTypeSystem GetDataTypeSystem()


Returns

OpcDataTypeSystem

An instance of the OpcDataTypeSystem class which can be used to understand the structure of the data exchanged using a specific type of encoding (see OpcEncodingType).



Exceptions

InvalidOperationException

The requested operation is currently not supported.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details.


Remarks

Querying the data type system may fail in case there MaxByteStringLength and MaxMessageSize are exceeded. The transport configuration needs to be adjusted to query larger type systems.

The OpcDataTypeSystem offered represents by default the data type system defined in address space of the server and its data type information is queried on-demand using different request operations. This “overhead” can be overcome using an offline stored OpcNodeSet which needs to be loaded and assigned to the NodeSet property of the current OpcClient.

In case there NodeSet property has been set to an instance of the OpcNodeSet class the offered OpcDataTypeSystem expresses the data type information contained in the NodeSet configured.

GetNodeType(OpcName)

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

C#

public OpcNodeTypeInfo GetNodeType(OpcName name)


Parameters

name OpcName

The OpcName of the OpcNodeTypeInfo object to retrieve.


Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).



Exceptions

ArgumentNullException

The name is a null reference (Nothing in Visual Basic).

GetNodeType(OpcNodeId)

Retrieves the OpcNodeTypeInfo object which declares the type which is identified by the typeId specified.

C#

public OpcNodeTypeInfo GetNodeType(OpcNodeId typeId)


Parameters

typeId OpcNodeId

The OpcNodeId which identifies the OpcNodeTypeInfo to retrieve.


Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcNodeTypeInfo object which is associated with the typeId specified.



Exceptions

ArgumentNullException

The typeId is a null reference (Nothing in Visual Basic).

GetNodeType(String)

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

C#

public OpcNodeTypeInfo GetNodeType(string name)


Parameters

name String

The String to use to identify the OpcNodeTypeInfo object to retrieve.


Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).



Exceptions

ArgumentException

The name is equals Empty.

ArgumentNullException

The name is a null reference (Nothing in Visual Basic).

GetNodeType(Type)

Retrieves the OpcNodeTypeInfo object which declares the type implemented by the underlyingType specified.

C#

public OpcNodeTypeInfo GetNodeType(Type underlyingType)


Parameters

underlyingType Type

The Type which implements the OpcNodeTypeInfo to retrieve.


Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcNodeTypeInfo object associated with the underlyingType specified.



Exceptions

ArgumentNullException

The underlyingType is a null reference (Nothing in Visual Basic).

GetNodeTypes()

Retrieves all OpcNodeTypeInfo objects offered by the IOpcTypeProvider.

C#

public OpcNodeTypeInfo[] GetNodeTypes()


Returns

OpcNodeTypeInfo[]

An array that contains all OpcNodeTypeInfo objects that are offered by the IOpcTypeProvider.

GetNodeTypeSystem()

Retrieves the system used to describe the type of nodes accessed on the server connected to.

C#

public OpcNodeTypeSystem GetNodeTypeSystem()


Returns

OpcNodeTypeSystem

An instance of the OpcNodeTypeSystem class which can be used to understand the structure of the nodes accessed.



Exceptions

InvalidOperationException

The requested operation is currently not supported.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details.


Remarks

The OpcNodeTypeSystem offered represents by default the node type system defined in address space of the server and its node type information is queried on-demand using different request operations. This “overhead” can be overcome using an offline stored OpcNodeSet which needs to be loaded and assigned to the NodeSet property of the current OpcClient.

In case there NodeSet property has been set to an instance of the OpcNodeSet class the offered OpcNodeTypeSystem expresses the node type information contained in the NodeSet configured.

OnBreakDetected(KeepAliveEventArgs)

Raises the BreakDetected event of the OpcClient.

C#

[CLSCompliant(false)]
protected virtual void OnBreakDetected(KeepAliveEventArgs e)


Parameters

e Client.KeepAliveEventArgs

The event data.

OnCertificateJudgement(OpcCertificateJudgementEventArgs)

Raises the CertificateJudgement event of the OpcClient.

C#

protected virtual void OnCertificateJudgement(OpcCertificateJudgementEventArgs e)


Parameters

e OpcCertificateJudgementEventArgs

The event data.

OnConnected(EventArgs)

Raises the Connected event of the OpcClient.

C#

protected virtual void OnConnected(EventArgs e)


Parameters

e EventArgs

The event data.

OnConnecting(EventArgs)

Raises the Connecting event of the OpcClient.

C#

protected virtual void OnConnecting(EventArgs e)


Parameters

e EventArgs

The event data.

OnDataChangeReceived(OpcDataChangeReceivedEventArgs)

Raises the DataChangeReceived event of the OpcClient.

C#

protected virtual void OnDataChangeReceived(OpcDataChangeReceivedEventArgs e)


Parameters

e OpcDataChangeReceivedEventArgs

The event data.

OnDialogRequested(OpcDialogRequestedEventArgs)

Raises the DialogRequested event of the OpcClient.

C#

protected virtual void OnDialogRequested(OpcDialogRequestedEventArgs e)


Parameters

e OpcDialogRequestedEventArgs

The event data.

OnDisconnected(EventArgs)

Raises the Disconnected event of the OpcClient.

C#

protected virtual void OnDisconnected(EventArgs e)


Parameters

e EventArgs

The event data.

OnDisconnecting(EventArgs)

Raises the Disconnecting event of the OpcClient.

C#

protected virtual void OnDisconnecting(EventArgs e)


Parameters

e EventArgs

The event data.

OnEventReceived(OpcEventReceivedEventArgs)

Raises the EventReceived event of the OpcClient.

C#

protected virtual void OnEventReceived(OpcEventReceivedEventArgs e)


Parameters

e OpcEventReceivedEventArgs

The event data.

OnNotificationReceived(OpcNotificationReceivedEventArgs)

Raises the NotificationReceived event of the OpcClient.

C#

protected virtual void OnNotificationReceived(OpcNotificationReceivedEventArgs e)


Parameters

e OpcNotificationReceivedEventArgs

The event data.

OnReconnected(EventArgs)

Raises the Reconnected event of the OpcClient.

C#

protected virtual void OnReconnected(EventArgs e)


Parameters

e EventArgs

The event data.

OnReconnecting(EventArgs)

Raises the Reconnecting event of the OpcClient.

C#

protected virtual void OnReconnecting(EventArgs e)


Parameters

e EventArgs

The event data.

OnStateChanged(OpcClientStateChangedEventArgs)

Raises the StateChanged event of the OpcClient.

C#

protected virtual void OnStateChanged(OpcClientStateChangedEventArgs e)


Parameters

e OpcClientStateChangedEventArgs

The event data.

OnSubscriptionsChanged(EventArgs)

C#

protected virtual void OnSubscriptionsChanged(EventArgs e)


Parameters

e EventArgs


ReadNode(Int32)

Reads the Value attribute of the node specified by nodeId.

C#

public OpcValue ReadNode(int nodeId)


Parameters

nodeId Int32

The numeric node identifier of the node to read.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId is equals zero.

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(Int32, Int32)

Reads the Value attribute of the node specified by nodeId and namespaceIndex.

C#

public OpcValue ReadNode(int nodeId, int namespaceIndex)


Parameters

nodeId Int32

The numeric node identifier of the node to read.

namespaceIndex Int32

The index of the namespace within that the node with the nodeId specified can be located.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId is an empty string.

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(Int32, Int32, OpcAttribute)

Reads the attribute of the node specified by nodeId and namespaceIndex.

C#

public OpcValue ReadNode(int nodeId, int namespaceIndex, OpcAttribute attribute)


Parameters

nodeId Int32

The numeric node identifier of the node to read.

namespaceIndex Int32

The index of the namespace within that the node with the nodeId specified can be located.

attribute OpcAttribute

One of the members defined by the OpcAttribute enumeration that defines which node attribute is to be used by the service.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId is equals zero.

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(Int32, OpcAttribute)

Reads the attribute of the node specified by nodeId.

C#

public OpcValue ReadNode(int nodeId, OpcAttribute attribute)


Parameters

nodeId Int32

The numeric node identifier of the node to read.

attribute OpcAttribute

One of the members defined by the OpcAttribute enumeration that defines which node attribute is to be used by the service.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId is equals zero.

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(OpcNodeId)

Reads the Value attribute of the node specified by nodeId.

C#

public OpcValue ReadNode(OpcNodeId nodeId)


Parameters

nodeId OpcNodeId

The OpcNodeId of the node to read.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId indicates to be a null-node-id (see IsNull).

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(OpcNodeId, OpcAttribute)

Reads the attribute of the node specified by nodeId.

C#

public OpcValue ReadNode(OpcNodeId nodeId, OpcAttribute attribute)


Parameters

nodeId OpcNodeId

The OpcNodeId of the node to read.

attribute OpcAttribute

One of the members defined by the OpcAttribute enumeration that defines which node attribute is to be used by the service.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId indicates to be a null-node-id (see IsNull).

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(OpcReadNode)

Reads the value of an attribute of a node using the specified command.

C#

public OpcValue ReadNode(OpcReadNode command)


Parameters

command OpcReadNode

The OpcReadNode instance to process.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested by the command.



Exceptions

ArgumentNullException

The command is a null reference (Nothing in Visual Basic).

InvalidOperationException

The read service is currently not supported, especially using the command specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(String)

Reads the Value attribute of the node specified by nodeId.

C#

public OpcValue ReadNode(string nodeId)


Parameters

nodeId String

The textual node identifier of the node to read.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId is an empty string.

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(String, Int32)

Reads the Value attribute of the node specified by nodeId and namespaceIndex.

C#

public OpcValue ReadNode(string nodeId, int namespaceIndex)


Parameters

nodeId String

The textual node identifier of the node to read.

namespaceIndex Int32

The index of the namespace within that the node with the nodeId specified can be located.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId is an empty string.

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(String, Int32, OpcAttribute)

Reads the attribute of the node specified by nodeId and namespaceIndex.

C#

public OpcValue ReadNode(string nodeId, int namespaceIndex, OpcAttribute attribute)


Parameters

nodeId String

The textual node identifier of the node to read.

namespaceIndex Int32

The index of the namespace within that the node with the nodeId specified can be located.

attribute OpcAttribute

One of the members defined by the OpcAttribute enumeration that defines which node attribute is to be used by the service.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId is an empty string.

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNode(String, OpcAttribute)

Reads the attribute of the node specified by nodeId.

C#

public OpcValue ReadNode(string nodeId, OpcAttribute attribute)


Parameters

nodeId String

The textual node identifier of the node to read.

attribute OpcAttribute

One of the members defined by the OpcAttribute enumeration that defines which node attribute is to be used by the service.


Returns

OpcValue

An instance of the OpcValue class which stores the value requested.



Exceptions

ArgumentException

The nodeId is an empty string.

ArgumentNullException

The nodeId is a null reference (Nothing in Visual Basic).

InvalidOperationException

The read service is currently not supported, especially using the arguments specified.

ObjectDisposedException

The object has been disposed of.

OpcException

The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.


Remarks

Known results for the operation are:

Status Description
BadNodeIdInvalid For more details see BadNodeIdInvalid.
BadNodeIdUnknown For more details see BadNodeIdUnknown.
BadAttributeInvalid For more details see BadAttributeInvalid.
BadIndexRangeInvalid For more details see BadIndexRangeInvalid.
BadIndexRangeNoData For more details see BadIndexRangeNoData.
BadDataEncodingInvalid For more details see BadDataEncodingInvalid.
BadDataEncodingUnsupported For more details see BadDataEncodingUnsupported.
BadNotReadable For more details see BadNotReadable.
BadUserAccessDenied For more details see BadUserAccessDenied.

ReadNodeHistory(Int32, Int32)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(int numberOfValues, int nodeId)


Parameters

numberOfValues Int32


nodeId Int32



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Int32, Int32, Int32)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(int numberOfValues, int nodeId, int namespaceIndex)


Parameters

numberOfValues Int32


nodeId Int32


namespaceIndex Int32



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Int32, OpcNodeId)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(int numberOfValues, OpcNodeId nodeId)


Parameters

numberOfValues Int32


nodeId OpcNodeId



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Int32, OpcReadNodeHistory)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(int numberOfValues, OpcReadNodeHistory command)


Parameters

numberOfValues Int32


command OpcReadNodeHistory



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Int32, String)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(int numberOfValues, string nodeId)


Parameters

numberOfValues Int32


nodeId String



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Int32, String, Int32)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(int numberOfValues, string nodeId, int namespaceIndex)


Parameters

numberOfValues Int32


nodeId String


namespaceIndex Int32



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Int32, Int32)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, int numberOfValues, int nodeId)


Parameters

startTime Nullable<DateTime>


numberOfValues Int32


nodeId Int32



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Int32, Int32, Int32)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, int numberOfValues, int nodeId, int namespaceIndex)


Parameters

startTime Nullable<DateTime>


numberOfValues Int32


nodeId Int32


namespaceIndex Int32



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Int32, OpcNodeId)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, int numberOfValues, OpcNodeId nodeId)


Parameters

startTime Nullable<DateTime>


numberOfValues Int32


nodeId OpcNodeId



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Int32, OpcReadNodeHistory)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, int numberOfValues, OpcReadNodeHistory command)


Parameters

startTime Nullable<DateTime>


numberOfValues Int32


command OpcReadNodeHistory



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Int32, String)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, int numberOfValues, string nodeId)


Parameters

startTime Nullable<DateTime>


numberOfValues Int32


nodeId String



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Int32, String, Int32)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, int numberOfValues, string nodeId, int namespaceIndex)


Parameters

startTime Nullable<DateTime>


numberOfValues Int32


nodeId String


namespaceIndex Int32



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, Int32)

C#

public IEnumerable<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, int nodeId)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


nodeId Int32



Returns

IEnumerable<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, Int32, Int32)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, int numberOfValues, int nodeId)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


numberOfValues Int32


nodeId Int32



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, Int32, Int32, Int32)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, int numberOfValues, int nodeId, int namespaceIndex)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


numberOfValues Int32


nodeId Int32


namespaceIndex Int32



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, Int32, OpcNodeId)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, int numberOfValues, OpcNodeId nodeId)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


numberOfValues Int32


nodeId OpcNodeId



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, Int32, OpcReadNodeHistory)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, int numberOfValues, OpcReadNodeHistory command)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


numberOfValues Int32


command OpcReadNodeHistory



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, Int32, String)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, int numberOfValues, string nodeId)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


numberOfValues Int32


nodeId String



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, Int32, String, Int32)

C#

public IOpcNodeHistoryNavigator<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, int numberOfValues, string nodeId, int namespaceIndex)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


numberOfValues Int32


nodeId String


namespaceIndex Int32



Returns

IOpcNodeHistoryNavigator<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, OpcNodeId)

C#

public IEnumerable<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, OpcNodeId nodeId)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


nodeId OpcNodeId



Returns

IEnumerable<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, OpcReadNodeHistory)

C#

public IEnumerable<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, OpcReadNodeHistory command)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


command OpcReadNodeHistory



Returns

IEnumerable<OpcHistoryValue>



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, String)

C#

public IEnumerable<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, string nodeId)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


nodeId String



Returns

IEnumerable<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistory(Nullable<DateTime>, Nullable<DateTime>, String, Int32)

C#

public IEnumerable<OpcHistoryValue> ReadNodeHistory(DateTime? startTime, DateTime? endTime, string nodeId, int namespaceIndex)


Parameters

startTime Nullable<DateTime>


endTime Nullable<DateTime>


nodeId String


namespaceIndex Int32



Returns

IEnumerable<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistoryAtTime(DateTime, Int32)

C#

public OpcHistoryValue ReadNodeHistoryAtTime(DateTime time, int nodeId)


Parameters

time DateTime


nodeId Int32



Returns

OpcHistoryValue



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistoryAtTime(DateTime, Int32, Int32)

C#

public OpcHistoryValue ReadNodeHistoryAtTime(DateTime time, int nodeId, int namespaceIndex)


Parameters

time DateTime


nodeId Int32


namespaceIndex Int32



Returns

OpcHistoryValue



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistoryAtTime(DateTime, OpcNodeId)

C#

public OpcHistoryValue ReadNodeHistoryAtTime(DateTime time, OpcNodeId nodeId)


Parameters

time DateTime


nodeId OpcNodeId



Returns

OpcHistoryValue



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistoryAtTime(DateTime, OpcReadNodeHistory)

C#

public OpcHistoryValue ReadNodeHistoryAtTime(DateTime time, OpcReadNodeHistory command)


Parameters

time DateTime


command OpcReadNodeHistory



Returns

OpcHistoryValue



Exceptions

ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistoryAtTime(DateTime, String)

C#

public OpcHistoryValue ReadNodeHistoryAtTime(DateTime time, string nodeId)


Parameters

time DateTime


nodeId String



Returns

OpcHistoryValue



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistoryAtTime(DateTime, String, Int32)

C#

public OpcHistoryValue ReadNodeHistoryAtTime(DateTime time, string nodeId, int namespaceIndex)


Parameters

time DateTime


nodeId String


namespaceIndex Int32



Returns

OpcHistoryValue



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistoryAtTime(DateTime[], Int32)

C#

public IEnumerable<OpcHistoryValue> ReadNodeHistoryAtTime(DateTime[] times, int nodeId)


Parameters

times DateTime[]


nodeId Int32



Returns

IEnumerable<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistoryAtTime(DateTime[], Int32, Int32)

C#

public IEnumerable<OpcHistoryValue> ReadNodeHistoryAtTime(DateTime[] times, int nodeId, int namespaceIndex)


Parameters

times DateTime[]


nodeId Int32


namespaceIndex Int32



Returns

IEnumerable<OpcHistoryValue>



Exceptions

ArgumentException


ArgumentNullException


InvalidOperationException


OpcException


ObjectDisposedException


ReadNodeHistoryAtTime(DateTime[], OpcNodeId)

C#

public IEnumerable<OpcHistoryValue> ReadNodeHistoryAtTime(DateTime[] times, OpcNodeId nodeId)


Parameters

times DateTime[]


nodeId OpcNodeId



Returns

IEnumerable<OpcHistoryValue>



Exceptions

ArgumentException