Namespace: Opc.UaFx
Assemblies: Opc.UaFx.Advanced.dll, Opc.UaFx.Advanced.dll
The OpcArgument type exposes the following members.
Initializes a new instance of the OpcArgument class using the name
of the argument to define an argument of the type Object.
C#
public OpcArgument(string name)
Parameters
name
String
The name of the argument.
Initializes a new instance of the OpcArgument class using the name
and dataType
of argument to define.
C#
public OpcArgument(string name, OpcDataType dataType)
Parameters
name
String
The name of the argument.
dataType
OpcDataType
One of the members defined by the OpcDataType enum to use to define the DataType and DataTypeId of the argument to define.
Initializes a new instance of the OpcArgument class using the name
and dataType
of argument to define.
C#
public OpcArgument(string name, OpcDataType dataType, bool isArray)
Parameters
name
String
The name of the argument.
dataType
OpcDataType
One of the members defined by the OpcDataType enum to use to define the DataType and DataTypeId of the argument to define.
isArray
Boolean
The value true, if the argument shall be an array; otherwise the value false.
Initializes a new instance of the OpcArgument class using the name
, dataType
, defaultValue
and description
of the argument to define.
C#
public OpcArgument(string name, OpcDataType dataType, bool isArray, object defaultValue, string description)
Parameters
name
String
The name of the argument.
dataType
OpcDataType
One of the members defined by the OpcDataType enum to use to define the DataType and DataTypeId of the argument to define.
isArray
Boolean
The value true, if the argument shall be an array; otherwise the value false.
defaultValue
Object
The value used in case there is no custom value specified for the argument.
description
String
The textual description of the use of the argument.
Initializes a new instance of the OpcArgument class using the name
, dataType
and description
of the argument to define.
C#
public OpcArgument(string name, OpcDataType dataType, bool isArray, string description)
Parameters
name
String
The name of the argument.
dataType
OpcDataType
One of the members defined by the OpcDataType enum to use to define the DataType and DataTypeId of the argument to define.
isArray
Boolean
The value true, if the argument shall be an array; otherwise the value false.
description
String
The textual description of the use of the argument.
Initializes a new instance of the OpcArgument class using the name
, dataType
, defaultValue
and description
of the argument to define.
C#
public OpcArgument(string name, OpcDataType dataType, object defaultValue, string description)
Parameters
name
String
The name of the argument.
dataType
OpcDataType
One of the members defined by the OpcDataType enum to use to define the DataType and DataTypeId of the argument to define.
defaultValue
Object
The value used in case there is no custom value specified for the argument.
description
String
The textual description of the use of the argument.
Initializes a new instance of the OpcArgument class using the name
, dataType
and description
of the argument to define.
C#
public OpcArgument(string name, OpcDataType dataType, string description)
Parameters
name
String
The name of the argument.
dataType
OpcDataType
One of the members defined by the OpcDataType enum to use to define the DataType and DataTypeId of the argument to define.
description
String
The textual description of the use of the argument.
Initializes a new instance of the OpcArgument class using the name
and dataType
of argument to define.
C#
public OpcArgument(string name, OpcDataType dataType, params uint[] arrayDimensions)
Parameters
name
String
The name of the argument.
dataType
OpcDataType
One of the members defined by the OpcDataType enum to use to define the DataType and DataTypeId of the argument to define.
arrayDimensions
UInt32[]
The length for each dimension of an array value of the argument represented.
Initializes a new instance of the OpcArgument class using the name
, dataType
, defaultValue
and description
of the argument to define.
C#
public OpcArgument(string name, OpcDataType dataType, uint[] arrayDimensions, object defaultValue, string description)
Parameters
name
String
The name of the argument.
dataType
OpcDataType
One of the members defined by the OpcDataType enum to use to define the DataType and DataTypeId of the argument to define.
arrayDimensions
UInt32[]
The length for each dimension of an array value of the argument represented.
defaultValue
Object
The value used in case there is no custom value specified for the argument.
description
String
The textual description of the use of the argument.
Initializes a new instance of the OpcArgument class using the name
, dataType
and description
of the argument to define.
C#
public OpcArgument(string name, OpcDataType dataType, uint[] arrayDimensions, string description)
Parameters
name
String
The name of the argument.
dataType
OpcDataType
One of the members defined by the OpcDataType enum to use to define the DataType and DataTypeId of the argument to define.
arrayDimensions
UInt32[]
The length for each dimension of an array value of the argument represented.
description
String
The textual description of the use of the argument.
Initializes a new instance of the OpcArgument class using the name
and dataTypeId
of argument to define.
C#
public OpcArgument(string name, OpcNodeId dataTypeId)
Parameters
name
String
The name of the argument.
dataTypeId
OpcNodeId
The identifier (DataTypeId) of the DataType to use for the argument to define.
Exceptions
The dataTypeId
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
and dataTypeId
of argument to define.
C#
public OpcArgument(string name, OpcNodeId dataTypeId, bool isArray)
Parameters
name
String
The name of the argument.
dataTypeId
OpcNodeId
The identifier (DataTypeId) of the DataType to use for the argument to define.
isArray
Boolean
The value true, if the argument shall be an array; otherwise the value false.
Exceptions
The dataTypeId
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
, dataTypeId
, defaultValue
and description
of the argument to define.
C#
public OpcArgument(string name, OpcNodeId dataTypeId, bool isArray, object defaultValue, string description)
Parameters
name
String
The name of the argument.
dataTypeId
OpcNodeId
The identifier (DataTypeId) of the DataType to use for the argument to define.
isArray
Boolean
The value true, if the argument shall be an array; otherwise the value false.
defaultValue
Object
The value used in case there is no custom value specified for the argument.
description
String
The textual description of the use of the argument.
Exceptions
The dataTypeId
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
, dataTypeId
and description
of the argument to define.
C#
public OpcArgument(string name, OpcNodeId dataTypeId, bool isArray, string description)
Parameters
name
String
The name of the argument.
dataTypeId
OpcNodeId
The identifier (DataTypeId) of the DataType to use for the argument to define.
isArray
Boolean
The value true, if the argument shall be an array; otherwise the value false.
description
String
The textual description of the use of the argument.
Exceptions
The dataTypeId
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
, dataTypeId
, defaultValue
and description
of the argument to define.
C#
public OpcArgument(string name, OpcNodeId dataTypeId, object defaultValue, string description)
Parameters
name
String
The name of the argument.
dataTypeId
OpcNodeId
The identifier (DataTypeId) of the DataType to use for the argument to define.
defaultValue
Object
The value used in case there is no custom value specified for the argument.
description
String
The textual description of the use of the argument.
Exceptions
The dataTypeId
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
, dataTypeId
and description
of the argument to define.
C#
public OpcArgument(string name, OpcNodeId dataTypeId, string description)
Parameters
name
String
The name of the argument.
dataTypeId
OpcNodeId
The identifier (DataTypeId) of the DataType to use for the argument to define.
description
String
The textual description of the use of the argument.
Exceptions
The dataTypeId
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
and dataTypeId
of argument to define.
C#
public OpcArgument(string name, OpcNodeId dataTypeId, params uint[] arrayDimensions)
Parameters
name
String
The name of the argument.
dataTypeId
OpcNodeId
The identifier (DataTypeId) of the DataType to use for the argument to define.
arrayDimensions
UInt32[]
The length for each dimension of an array value of the argument represented.
Exceptions
The dataTypeId
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
, dataTypeId
, defaultValue
and description
of the argument to define.
C#
public OpcArgument(string name, OpcNodeId dataTypeId, uint[] arrayDimensions, object defaultValue, string description)
Parameters
name
String
The name of the argument.
dataTypeId
OpcNodeId
The identifier (DataTypeId) of the DataType to use for the argument to define.
arrayDimensions
UInt32[]
The length for each dimension of an array value of the argument represented.
defaultValue
Object
The value used in case there is no custom value specified for the argument.
description
String
The textual description of the use of the argument.
Exceptions
The dataTypeId
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
, dataTypeId
and description
of the argument to define.
C#
public OpcArgument(string name, OpcNodeId dataTypeId, uint[] arrayDimensions, string description)
Parameters
name
String
The name of the argument.
dataTypeId
OpcNodeId
The identifier (DataTypeId) of the DataType to use for the argument to define.
arrayDimensions
UInt32[]
The length for each dimension of an array value of the argument represented.
description
String
The textual description of the use of the argument.
Exceptions
The dataTypeId
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
and type
of argument to define.
C#
public OpcArgument(string name, Type type)
Parameters
name
String
The name of the argument.
type
Type
The Type of argument.
Exceptions
The type
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
, type
, defaultValue
and description
of the argument to define.
C#
public OpcArgument(string name, Type type, object defaultValue, string description)
Parameters
name
String
The name of the argument.
type
Type
The Type of argument.
defaultValue
Object
The value used in case there is no custom value specified for the argument.
description
String
The textual description of the use of the argument.
Exceptions
The type
is a null reference (Nothing in Visual Basic).
Initializes a new instance of the OpcArgument class using the name
, type
and description
of the argument to define.
C#
public OpcArgument(string name, Type type, string description)
Parameters
name
String
The name of the argument.
type
Type
The Type of argument.
description
String
The textual description of the use of the argument.
Exceptions
The type
is a null reference (Nothing in Visual Basic).
Gets the length for each dimension of an array value of the argument represented.
C#
public uint[] ArrayDimensions { get; }
Property Value
UInt32[]
An empty array in case there the value of the argument represented is a scalar value; otherwise an UInt32 array there each entry indicates a single dimension while the value of the entry defines the length of that dimension.
Gets the total number of elements in all the dimensions of the array value of the argument represented.
C#
public long ArrayLength { get; }
Property Value
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.
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.
C#
public int ArrayRank { get; }
Property Value
The rank (number of dimensions) of the array value of the argument represented.
Gets the underlying built-in data type used by the argument.
C#
public OpcDataType DataType { get; }
Property Value
One of the members defined by the OpcDataType enumeration which defines the data type of the argument.
Gets the value of the argument that is by default used in case there is no custom value specified for the argument.
C#
public object DefaultValue { get; }
Property Value
The default value used by argument by definition.
Gets the textual description of the use of the argument represented.
C#
public OpcText Description { get; }
Property Value
A string which describes the use of the argument.
Gets the OpcArgumentGlobalization instance used to control the localization and other globalization related tasks for the Description of the current attribute.
C#
public OpcArgumentGlobalization Descriptions { get; }
Property Value
An instance of the OpcArgumentGlobalization class used for the current OpcArgument to perform localization tasks for its Description.
Gets a value indicating whether the value of the argument represented is an array.
C#
public bool IsArray { get; }
Property Value
The value true if the value of the argument represented is an array; otherwise the false.
Gets the name of the argument.
C#
public string Name { get; }
Property Value
A value which identifies the argument using a simple name.
Remarks
The String used as the name of the argument does not rely on any naming-rules which typically apply to names in programming languages. Therefore it is possible to use whitespaces and special characters as well. There exists no restriction regarding the naming of an argument.
Gets a 32-bit integer that represents the number of elements in the specified dimension of the array value of the argument.
C#
public long GetArrayLength(int dimension)
Parameters
dimension
Int32
A zero-based dimension of the array value whose length needs to be determined.
Returns
A 32-bit integer that represents the number of elements in the specified dimension of the array value.
Exceptions
The dimension
is less than zero or equals to or greater than ArrayRank.
The value of the argument represented is not an array (see IsArray).
Gets the index of the first element of the specified dimension in the array value of the argument.
C#
public long GetArrayLowerBound(int dimension)
Parameters
dimension
Int32
A zero-based dimension of the array value whose starting index needs to be determined.
Returns
The index of the first element of the specified dimension in the array value.
Exceptions
The dimension
is less than zero or equals to or greater than ArrayRank.
The value of the argument represented is not an array (see IsArray).
Gets the index of the last element of the specified dimension in the array value of the argument.
C#
public long GetArrayUpperBound(int dimension)
Parameters
dimension
Int32
A zero-based dimension of the array value whose upper bound needs to be determined.
Returns
The index of the last element of the specified dimension in the array value, or -1 if the specified dimension is empty.
Exceptions
The dimension
is less than zero or equals to or greater than ArrayRank.
The value of the argument represented is not an array (see IsArray).