OPC Studio User's Guide and Reference
ResolveEncodingIdFromModelNodeDescriptor Method (IUADataTypeModelProviderExtension)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.DataTypeModel.Extensions Namespace > IUADataTypeModelProviderExtension Class : ResolveEncodingIdFromModelNodeDescriptor Method
The OPC UA data type model provider.

This is typically obtained from the OpcLabs.EasyOpc.UA.Plugins.ComplexData.IEasyUAClientComplexData.DataTypeModelProvider property of the OpcLabs.EasyOpc.UA.Plugins.ComplexData.IEasyUAClientComplexData service.

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

A model node descriptor.

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

The encoding name.

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 this parameter, 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 UAQualifiedName Constructor(String) constructor instead.

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

Resolves an encoding ID from given model node descriptor and an encoding name.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function ResolveEncodingIdFromModelNodeDescriptor( _
   ByVal dataTypeModelProvider As IUADataTypeModelProvider, _
   ByVal modelNodeDescriptor As UAModelNodeDescriptor, _
   ByVal encodingName As UAQualifiedName _
) As ValueResult(Of UAModelNodeDescriptor)
'Usage
 
Dim dataTypeModelProvider As IUADataTypeModelProvider
Dim modelNodeDescriptor As UAModelNodeDescriptor
Dim encodingName As UAQualifiedName
Dim value As ValueResult(Of UAModelNodeDescriptor)
 
value = IUADataTypeModelProviderExtension.ResolveEncodingIdFromModelNodeDescriptor(dataTypeModelProvider, modelNodeDescriptor, encodingName)

Parameters

dataTypeModelProvider
The OPC UA data type model provider.

This is typically obtained from the OpcLabs.EasyOpc.UA.Plugins.ComplexData.IEasyUAClientComplexData.DataTypeModelProvider property of the OpcLabs.EasyOpc.UA.Plugins.ComplexData.IEasyUAClientComplexData service.

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

modelNodeDescriptor
A model node descriptor.

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

encodingName
The encoding name.

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 this parameter, 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 UAQualifiedName Constructor(String) constructor instead.

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

Return Value

A value result with the encoding ID obtained.

This method never returns null (Nothing in Visual Basic).

Remarks

The standard browse names to be used with encodingName are:

You can obtain the data type model provider interface (OpcLabs.EasyOpc.UA.DataTypeModel.IUADataTypeModelProvider) from the OpcLabs.EasyOpc.UA.Plugins.ComplexData.IEasyUAClientComplexData.DataTypeModelProvider property of the OpcLabs.EasyOpc.UA.Plugins.ComplexData.IEasyUAClientComplexData service.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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