Docs
DEEN

Reference

OpcEncodingStackFrame Members

Provides information about a OpcEncodingStackFrame, which represents the encoding / decoding operation performed on the encoding stack for the current encode / decode operation.

Reference

OpcEncodingStackFrame Members ​

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

Properties ​

Data ​

Gets the data which is about to encode / decode.

csharp
public object Data { get; }
vbnet
Public ReadOnly Property Data As Object

Property value

Object

An object instance which depends on the encoder / decoder used.

Encoding ​

Gets the type of encoding supported by the encoder / decoder used.

csharp
public OpcEncodingType Encoding { get; }
vbnet
Public ReadOnly Property Encoding As OpcEncodingType

Property value

OpcEncodingType

One of the members defined by the OpcEncodingType enumeration.

Exception ​

Gets the Exception created or caught during the encoding / decoding operation.

csharp
public Exception Exception { get; }
vbnet
Public ReadOnly Property Exception As Exception

Property value

Exception

An instance of the Exception class or a null reference (Nothing in Visual Basic) in case there was no Exception encountered during the operation of this OpcEncodingStackFrame.

FieldName ​

Gets the name of the field of an Instance which is about to get encoded / decoded.

csharp
public string FieldName { get; }
vbnet
Public ReadOnly Property FieldName As String

Property value

String

The name of the field to encode / decode or a null reference (Nothing in Visual Basic) if there is no field name known by the encoder / decoder for the current operation of this OpcEncodingStackFrame.

FieldType ​

Gets the type of the field being encoded / decoded.

csharp
public Type FieldType { get; }
vbnet
Public ReadOnly Property FieldType As Type

Property value

Type

The Type of the field to encode / decode or a null reference (Nothing in Visual Basic) if there is no Type known by the encoder / decoder for the current operation of this OpcEncodingStackFrame.

Instance ​

Gets the object instance its data is being encoded / decoded.

csharp
public object Instance { get; }
vbnet
Public ReadOnly Property Instance As Object

Property value

Object

An object instance or a null reference (Nothing in Visual Basic) in case there the encoder / decoder is not about to encode / decode an instance.

Message ​

Gets the description of the outcome of the current encoding / decoding operation.

csharp
public string Message { get; }
vbnet
Public ReadOnly Property Message As String

Property value

String

The description of the outcome of the current encoding / decoding operation or a null reference (Nothing in Visual Basic) in the case there the encoding / decoding operation does not offer a description for its outcome.

MethodName ​

Gets the name of the encoder / decoder method in which the frame is executing.

csharp
public string MethodName { get; }
vbnet
Public ReadOnly Property MethodName As String

Property value

String

The name of the method in which the frame is executing.

Position ​

Gets the zero-based position of the encoder / decoder within its underlying stream during the operation of the current OpcEncodingStackFrame.

csharp
public long Position { get; }
vbnet
Public ReadOnly Property Position As Long

Property value

Int64

The position within the stream of the encoder / decoder.

TypeId ​

Gets the identifier of the type being encoded / decoded.

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

Property value

OpcNodeId

An instance of the OpcNodeId class which identifies the type being encoded / decoded by the operation of the current OpcEncodingStackFrame or a null reference (Nothing in Visual Basic) if the operation is in a context there a type identifier does not apply to the current operation of the OpcEncodingStackFrame.

TypeIdAbsolute ​

Gets the absolute TypeId (if available).

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

Property value

OpcNodeId

The absolute TypeId in case there the TypeId has been resolved or a null reference (Nothing in Visual Basic) if the TypeId hasn't been resolved.

Methods ​

ToString ​

override

Returns a readable representation of the stack frame.

csharp
public override string ToString()
vbnet
Public Overrides Function ToString() As String

Returns

String

A string representing the information of the current OpcEncodingStackFrame in a readable way.

Overrides

ToString()