EncodingName Property (UAReadParameters)

Name of the encoding that the server should use when returning the Value attribute of a variable.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<TypeConverterAttribute(OpcLabs.EasyOpc.UA.AddressSpace.Implementation.UAEncodingNameConverter)>
Public Property EncodingName As UAQualifiedName

'Usage
 
Dim instance As UAReadParameters
Dim value As UAQualifiedName
 
instance.EncodingName = value
 
value = instance.EncodingName

[TypeConverter(OpcLabs.EasyOpc.UA.AddressSpace.Implementation.UAEncodingNameConverter)]
public UAQualifiedName EncodingName {get; set;}

[TypeConverter(OpcLabs.EasyOpc.UA.AddressSpace.Implementation.UAEncodingNameConverter)]
public:
property UAQualifiedName^ EncodingName {
   UAQualifiedName^ get();
   void set (    UAQualifiedName^ value);
}

Remarks

The encoding name is not specified when the value of this property is OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName.Null. It is an error to specify this parameter for attributes other than UAAttributeId.Value.

"A Client can discover what DataTypeEncodings are available by following the HasEncoding Reference from the DataType Node for a Variable.

OPC UA defines BrowseNames which Servers shall recognize even if the DataType Nodes are not visible in the Server AddressSpace. These BrowseNames are:

Default Binary: The default or native binary(or non-XML) encoding.
Default XML: The default XML encoding.

Each DataType shall support at least one of these encodings. DataTypes that do not have a true binary encoding (e.g. they only have a non-XML text encoding) should use the Default Binary name to identify the encoding that is considered to be the default non-XML encoding. DataTypes that support at least one XML-based encoding shall identify one of the encodings as the Default XML encoding. Other standards bodies may define other well-known data encodings that could be supported.

If this parameter is not specified then the Server shall choose either the Default Binary or Default XML encoding according to what Message encoding (see Part 6) is used for the Session. If the Server does not support the encoding that matches the Message encoding then the Server shall choose the default encoding that it does support."

The standard browse names to be used with this property are:

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

UAReadParameters Class
UAReadParameters Members
DefaultEncodingName Property
FromUAQualifiedName Method

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.