OPC Studio User's Guide and Reference
GetDataTypeInfoFromDataTypeId Method (IUADataTypeDefinitionProviderExtension)



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

This is typically obtained from the OpcLabs.EasyOpc.UA.Plugins.ComplexData.IEasyUAClientComplexData.DataTypeDefinitionProvider 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 ID.

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

Determines whether the provider will attempt to recursively look at supertypes when determining the data type info.
Determines whether base data types will always be included in the result.
In DataTypeDefinition model, gets a data type info from given data type ID.
Syntax
'Declaration
 
<ExtensionAttribute()>
<CanBeNullAttribute()>
Public Shared Function GetDataTypeInfoFromDataTypeId( _
   ByVal dataTypeDefinitionProvider As IUADataTypeDefinitionProvider, _
   ByVal dataTypeId As UAModelNodeDescriptor, _
   ByVal searchSupertypes As Boolean, _
   ByVal requireBaseDataType As Boolean _
) As ValueResult(Of UADataTypeInfo)
'Usage
 
Dim dataTypeDefinitionProvider As IUADataTypeDefinitionProvider
Dim dataTypeId As UAModelNodeDescriptor
Dim searchSupertypes As Boolean
Dim requireBaseDataType As Boolean
Dim value As ValueResult(Of UADataTypeInfo)
 
value = IUADataTypeDefinitionProviderExtension.GetDataTypeInfoFromDataTypeId(dataTypeDefinitionProvider, dataTypeId, searchSupertypes, requireBaseDataType)

Parameters

dataTypeDefinitionProvider
The OPC UA data type model provider.

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

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

dataTypeId
A data type ID.

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

searchSupertypes
Determines whether the provider will attempt to recursively look at supertypes when determining the data type info.
requireBaseDataType
Determines whether base data types will always be included in the result.

Return Value

A value result with the data type info obtained.

This method can return null (Nothing in Visual Basic).

Remarks

Success result with null value indicates that the data type info is not present for the data type ID.

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