Reference

OpcArgumentInfo Members

Type

OpcArgumentInfo

Namespace

Opc.UaFx.Client

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

ArrayDimensions

Gets the length for each dimension of an array value of the argument represented.

public uint[] ArrayDimensions { get; }

Public ReadOnly Property ArrayDimensions As UInteger()

Property value

UInt32[]

An empty array in case there the value of the argument represented is a scalar value; otherwise an uint array there each entry indicates a single dimension while the value of the entry defines the length of that dimension or a null reference (Nothing in Visual Basic) if ArrayRank is less or equals zero.

ArrayLength

Gets the total number of elements in all the dimensions of the array value of the argument represented.

public long ArrayLength { get; }

Public ReadOnly Property ArrayLength As Long

Property value

Int64

The total number of elements in all the dimensions of the array value of the argument represented; zero if there are no elements in the array.

ArrayRank

Gets the rank (number of dimensions) of the array value of the argument represented. For example, a one-dimensional array returns 1, a two-dimensional array returns 2, and so on.

public int ArrayRank { get; }

Public ReadOnly Property ArrayRank As Integer

Property value

Int32

The rank (number of dimensions) of the array value of the argument represented.

DataType

Gets the OpcTypeNodeInfo about the data type node of the argument represented.

public OpcTypeNodeInfo DataType { get; }

Public ReadOnly Property DataType As OpcTypeNodeInfo

Property value

OpcTypeNodeInfo

An instance of the OpcTypeNodeInfo representing the type definition of the argument represented. In case there is no known type definition for the data type referenced by the argument a null reference (Nothing in Visual Basic).

DataTypeId

Gets the OpcNodeId about the data type node of the argument represented.

public OpcNodeId DataTypeId { get; }

Public ReadOnly Property DataTypeId As OpcNodeId

Property value

OpcNodeId

An instance of the OpcNodeId which identifies the type node definition of the argument represented. In case there is no type definition for the type of value provided by the argument represented a null reference (Nothing in Visual Basic).

DefaultValue

Gets the value of the argument that is by default used in case there is no custom value specified for the argument.

public object DefaultValue { get; }

Public ReadOnly Property DefaultValue As Object

Property value

Object

The default value used by argument by definition.

Description

Gets the textual description of the use of the argument represented.

public OpcText Description { get; }

Public ReadOnly Property Description As OpcText

Property value

OpcText

A string which describes the use of the argument.

IsArray

Gets a value indicating whether the value of the argument represented is an array.

public bool IsArray { get; }

Public ReadOnly Property IsArray As Boolean

Property value

Boolean

The value true if the value of the argument represented is an array; otherwise the false.

Name

Gets the name of the argument.

public string Name { get; }

Public ReadOnly Property Name As String

Property value

String

The name of the argument.

Methods

GetArrayLength

Gets a 32-bit integer that represents the number of elements in the specified dimension of the array value of the argument.

public long GetArrayLength(int dimension)

Public Function GetArrayLength(dimension As Integer) As Long

Parameters

Name	Type	Description
dimension	Int32	A zero-based dimension of the array value whose length needs to be determined.

Returns

Int64

A 32-bit integer that represents the number of elements in the specified dimension of the array value.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The dimension is less than zero or equals to or greater than ArrayRank.
InvalidOperationException	The value of the argument represented is not an array (see IsArray).

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the ArrayDimensions attribute is requested on-demand and is cached for subsequent calls. This means, that further ArrayDimensions attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

GetArrayLowerBound

Gets the index of the first element of the specified dimension in the array value of the argument.

public long GetArrayLowerBound(int dimension)

Public Function GetArrayLowerBound(dimension As Integer) As Long

Parameters

Name	Type	Description
dimension	Int32	A zero-based dimension of the array value whose starting index needs to be determined.

Returns

Int64

The index of the first element of the specified dimension in the array value.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The dimension is less than zero or equals to or greater than ArrayRank.
InvalidOperationException	The value of the argument represented is not an array (see IsArray).

GetArrayUpperBound

Gets the index of the last element of the specified dimension in the array value of the argument.

public long GetArrayUpperBound(int dimension)

Public Function GetArrayUpperBound(dimension As Integer) As Long

Parameters

Name	Type	Description
dimension	Int32	A zero-based dimension of the array value whose upper bound needs to be determined.

Returns

Int64

The index of the last element of the specified dimension in the array value, or -1 if the specified dimension is empty.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The dimension is less than zero or equals to or greater than ArrayRank.
InvalidOperationException	The value of the argument represented is not an array (see IsArray).

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the ArrayDimensions attribute is requested on-demand and is cached for subsequent calls. This means, that further ArrayDimensions attribute requests will take use of already retrieved attribute information and will not demand additional network resources.