OPC Studio User's Guide and Reference
GetDataTypeDescriptionIdFromDataTypeEncodingId Method (IUADataTypeDictionaryProviderExtension)



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

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

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

A data type encoding ID.

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

In DataTypeDictionary model, gets a data type description ID from given data type encoding ID.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function GetDataTypeDescriptionIdFromDataTypeEncodingId( _
   ByVal dataTypeDictionaryProvider As IUADataTypeDictionaryProvider, _
   ByVal dataTypeEncodingId As UAModelNodeDescriptor _
) As ValueResult(Of UAModelNodeDescriptor)
'Usage
 
Dim dataTypeDictionaryProvider As IUADataTypeDictionaryProvider
Dim dataTypeEncodingId As UAModelNodeDescriptor
Dim value As ValueResult(Of UAModelNodeDescriptor)
 
value = IUADataTypeDictionaryProviderExtension.GetDataTypeDescriptionIdFromDataTypeEncodingId(dataTypeDictionaryProvider, dataTypeEncodingId)

Parameters

dataTypeDictionaryProvider
The OPC UA data type model provider.

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

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

dataTypeEncodingId
A data type encoding ID.

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

Return Value

A value result with the data type description ID obtained.

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

Remarks

You can obtain the data type model provider interface (OpcLabs.EasyOpc.UA.DataTypeModel.IUADataTypeDictionaryProvider) from the OpcLabs.EasyOpc.UA.Plugins.ComplexData.IEasyUAClientComplexData.DataTypeDictionaryProvider 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