OPC Studio User's Guide and Reference
EncodingName Property (UAReadParameters)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA Namespace > UAReadParameters Class : EncodingName Property
Name of the encoding that the server should use when returning the Value attribute of a variable.
Syntax
'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);
}

Property Value

The value of this property cannot be null (Nothing in Visual Basic).

Because the OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName has an implicit conversion to System.String, and it converts to the expanded text of the qualified name (OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName.ExpandedText), in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName in any place where expanded text of a qualified name (a string) is expected as input, and the corresponding expanded text will be taken automatically from the qualified name.

Also, because the OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement has an implicit conversion from OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName (containing a target qualified name, which becomes the "any hierarchical" forward reference) in any place where OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement is expected as input, and the corresponding OPC UA browse path element will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement.FromUAQualifiedName static method instead.

Also, because the UAReadParameters has an implicit conversions from OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply the returned OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName (representing the name of the encoding to be used) in any place where UAReadParameters is expected as input, and the corresponding OPC UA read parameters will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromDouble or FromUAQualifiedName static method instead.

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

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 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:

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:

Because the OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the qualified name) in place of OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName value when setting this property, and the corresponding OPC UA qualified name will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName.UAQualifiedName Constructor(String) constructor instead.

Requirements

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

See Also