Skip to content

Reference

OpcCallMethod Members

Defines a single command of the IOpcCallMethodsService.

Reference

OpcCallMethod Members ​

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

Inherits members from OpcNodeServiceCommand, OpcServiceCommand.

Constructors ​

OpcCallMethod ​

3 overloads

OverloadDescription
OpcCallMethod(OpcNodeId, OpcNodeId)Initializes a new instance of the OpcCallMethod class using the specified objectId and methodId to call the method without parameters.
OpcCallMethod(OpcNodeId, OpcNodeId, IEnumerable<object>)Initializes a new instance of the OpcCallMethod class using the specified objectId, methodId and parameters.
OpcCallMethod(OpcNodeId, OpcNodeId, params object[])Initializes a new instance of the OpcCallMethod class using the specified objectId, methodId and parameters.

Exceptions (all overloads)

ExceptionCondition
ArgumentExceptionThe objectId is a null identifier (see IsNull).

OpcCallMethod(OpcNodeId, OpcNodeId) ​

Initializes a new instance of the OpcCallMethod class using the specified objectId and methodId to call the method without parameters.

csharp
public OpcCallMethod(OpcNodeId objectId, OpcNodeId methodId)
vbnet
Public Sub New(objectId As OpcNodeId, methodId As OpcNodeId)

Parameters

NameTypeDescription
objectIdOpcNodeIdThe OpcNodeId of the object node or object type node which provides the method.
methodIdOpcNodeIdThe OpcNodeId of the method node to call.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe objectId or methodId is a null reference (Nothing in Visual Basic).

OpcCallMethod(OpcNodeId, OpcNodeId, IEnumerable<object>) ​

Initializes a new instance of the OpcCallMethod class using the specified objectId, methodId and parameters.

csharp
public OpcCallMethod(
    OpcNodeId objectId,
    OpcNodeId methodId,
    IEnumerable<object> parameters)
vbnet
Public Sub New(
    objectId As OpcNodeId,
    methodId As OpcNodeId,
    parameters As IEnumerable(Of Object))

Parameters

NameTypeDescription
objectIdOpcNodeIdThe OpcNodeId of the object node or object type node which provides the method.
methodIdOpcNodeIdThe OpcNodeId of the method node to call.
parametersIEnumerable<Object>The values of the input arguments of the method in their order.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe objectId, methodId or parameters is a null reference (Nothing in Visual Basic).

Remarks

The command does not copy the parameters; they are enumerated when the command is executed and when Parameters is read.

OpcCallMethod(OpcNodeId, OpcNodeId, params object[]) ​

Initializes a new instance of the OpcCallMethod class using the specified objectId, methodId and parameters.

csharp
public OpcCallMethod(
    OpcNodeId objectId,
    OpcNodeId methodId,
    params object[] parameters)
vbnet
Public Sub New(
    objectId As OpcNodeId,
    methodId As OpcNodeId,
    ParamArray parameters As Object())

Parameters

NameTypeDescription
objectIdOpcNodeIdThe OpcNodeId of the object node or object type node which provides the method.
methodIdOpcNodeIdThe OpcNodeId of the method node to call.
parametersparams Object[]The values of the input arguments of the method in their order.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe objectId, methodId or parameters is a null reference (Nothing in Visual Basic).

Remarks

The command does not copy the parameters, so that changes of the array are applied to the command.

Properties ​

MethodId ​

Gets the identifier of the method node to call.

csharp
public OpcNodeId MethodId { get; }
vbnet
Public ReadOnly Property MethodId As OpcNodeId

Property value

OpcNodeId

The OpcNodeId of the method node to call.

ObjectId ​

Gets the identifier of the node which provides the method to call.

csharp
public OpcNodeId ObjectId { get; }
vbnet
Public ReadOnly Property ObjectId As OpcNodeId

Property value

OpcNodeId

The OpcNodeId of the object node or object type node which provides the method.

Parameters ​

Gets the values of the input arguments of the method.

csharp
public IEnumerable<object> Parameters { get; }
vbnet
Public ReadOnly Property Parameters As IEnumerable(Of Object)

Property value

IEnumerable<Object>

A new array of the values of the input arguments of the method in their order.