OpcClient Members

Initializes a new instance of the OpcClient class.

C#

public OpcClient()

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.

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.

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).

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).

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

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

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

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

Occurs when a connection break has been detected.

C#

public event EventHandler BreakDetected

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.

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

C#

public event EventHandler Connected

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

C#

public event EventHandler Connecting

C#

public event OpcDataChangeReceivedEventHandler DataChangeReceived

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.

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

C#

public event EventHandler Disconnected

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

C#

public event EventHandler Disconnecting

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.

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

C#

public event OpcNotificationReceivedEventHandler NotificationReceived

Occurs when the OpcClient has successfully re-established a broken connection to the server using the previously used session.

C#

public event EventHandler Reconnected

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

C#

public event EventHandler Reconnecting

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

C#

public event EventHandler<OpcClientStateChangedEventArgs> StateChanged

C#

public event EventHandler SubscriptionsChanged

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).

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.

C#

public OpcSubscription DefaultSubscription { get; set; }

Property Value

OpcSubscription

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.

Gets the OpcClientInterfaces instance which provides options to control the access to the different OPC Classic interfaces used/provided by the OpcClient.

C#

public OpcClientInterfaces Interfaces { get; }

Property Value

OpcClientInterfaces

An instance of the OpcClientInterfaces class which can be used to control the access to the different interfaces accessed.

C#

public OpcClientKeepAlive KeepAlive { get; }

Property Value

OpcClientKeepAlive

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.

Gets a read-only collection of namespaces used by the server connected to.

C#

public override OpcReadOnlyNamespaceCollection Namespaces { get; }

Property Value

OpcReadOnlyNamespaceCollection

An instance of the OpcReadOnlyNamespaceCollection class with OpcNamespace items for each 'NamespaceUri' used by the server to organize the nodes in its address space.

Remarks

The items in the OpcReadOnlyNamespaceCollection provided are created while a connection is established to the server. The items are additionally re-created whenever the OpcClient reconnects to the server.

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).

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.

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.

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).

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.

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.

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.

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.

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.

C#

public OpcSubscriptionReadOnlyCollection Subscriptions { get; }

Property Value

OpcSubscriptionReadOnlyCollection

Gets the OpcContext which is used to store the context sensitive data and configuration used by the current OpcClient instance.

C#

public override OpcContext SystemContext { get; }

Property Value

OpcContext

An instance of the OpcContext class which might be at least Empty.

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.

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.

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.

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

C#

public OpcNodeInfo BrowseNode(OpcBrowseNode command)

Parameters

command OpcBrowseNode

Returns

OpcNodeInfo

Exceptions

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

C#

public OpcNodeInfo BrowseNode(OpcNodeId nodeId)

Parameters

nodeId OpcNodeId

Returns

OpcNodeInfo

Exceptions

ArgumentNullException

InvalidOperationException

ObjectDisposedException

C#

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

Parameters

nodeId OpcNodeId

referenceTypes IEnumerable<OpcReferenceType>

Returns

OpcNodeInfo

Exceptions

ArgumentNullException

InvalidOperationException

ObjectDisposedException

C#

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

Parameters

nodeId OpcNodeId

referenceTypes OpcReferenceType[]

Returns

OpcNodeInfo

Exceptions

ArgumentNullException

InvalidOperationException

ObjectDisposedException

C#

public OpcNodeInfo BrowseNode(OpcViewDescription view, OpcNodeId nodeId)

Parameters

view OpcViewDescription

nodeId OpcNodeId

Returns

OpcNodeInfo

Exceptions

ArgumentNullException

InvalidOperationException

ObjectDisposedException

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

C#

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

Parameters

view OpcViewDescription

nodeId OpcNodeId

referenceTypes OpcReferenceType[]

Returns

OpcNodeInfo

Exceptions

ArgumentNullException

InvalidOperationException

ObjectDisposedException

C#

public IEnumerable<OpcNodeId> BrowseNodeIds(BrowsePathCollection pathsToTranslate)

Parameters

pathsToTranslate BrowsePathCollection

Returns

IEnumerable<OpcNodeId>

C#

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

Parameters

commands IEnumerable<OpcBrowseNode>

Returns

IEnumerable<OpcNodeInfo>

Exceptions

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

C#

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

Parameters

commands OpcBrowseNode[]

Returns

IEnumerable<OpcNodeInfo>

Exceptions

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

C#

public void CallAction(OpcNodeId objectId, OpcNodeId methodId)

Parameters

objectId OpcNodeId

methodId OpcNodeId

C#

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

Parameters

objectId OpcNodeId

methodId OpcNodeId

parameter T

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

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

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

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

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

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

C#

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

Parameters

objectId OpcNodeId

methodId OpcNodeId

parameter1 1

parameter2 2

C#

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

Parameters

objectId OpcNodeId

methodId OpcNodeId

parameter T

Returns

t

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

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

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

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

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

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

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

C#

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

Parameters

objectId OpcNodeId

methodId OpcNodeId

Returns

t

C#

public object[] CallMethod(OpcCallMethod command)

Parameters

command OpcCallMethod

Returns

Object[]

Exceptions

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

C#

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

Parameters

objectId OpcNodeId

methodId OpcNodeId

Returns

Object[]

Exceptions

ArgumentException

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

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

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

C#

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

Parameters

commands IEnumerable<OpcCallMethod>

Returns

Object[][]

Exceptions

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

C#

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

Parameters

commands OpcCallMethod[]

Returns

Object[][]

Exceptions

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

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.

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()

C#

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

Parameters

nodeId Int32

values IEnumerable<OpcValue>

Returns

OpcStatusCollection

Exceptions

ArgumentException

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

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

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

C#

public OpcStatus CreateNodeHistory(int nodeId, OpcValue value)

Parameters

nodeId Int32

value OpcValue

Returns

OpcStatus

Exceptions

ArgumentException

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

C#

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

Parameters

nodeId Int32

values OpcValue[]

Returns

OpcStatusCollection

Exceptions

ArgumentException

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

C#

public OpcStatusCollection CreateNodeHistory(OpcCreateNodeHistory command)

Parameters

command OpcCreateNodeHistory

Returns

OpcStatusCollection

Exceptions

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

C#

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

Parameters

nodeId OpcNodeId

values IEnumerable<OpcValue>

Returns

OpcStatusCollection

Exceptions

ArgumentException

ArgumentNullException

InvalidOperationException

OpcException

ObjectDisposedException

C#

public OpcStatus CreateNodeHistory(OpcNodeId nodeId, OpcValue value)

Parameters

nodeId OpcNodeId