OPC Studio User's Guide and Reference
EncodeInDataTypeDictionaryModel Method (IUADataTypeSystem)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.DataTypeModel Namespace > IUADataTypeSystem Interface : EncodeInDataTypeDictionaryModel Method
Identifies an OPC UA data type together with its data type dictionary.

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

The generic data to be encoded.

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

In DataTypeDictionary model, encodes generic data according to given data type descriptor.
Syntax
'Declaration
 
<NotNullAttribute()>
Function EncodeInDataTypeDictionaryModel( _
   ByVal dataTypeDescriptor As UADataTypeDescriptor, _
   ByVal genericData As GenericData _
) As ValueResult
'Usage
 
Dim instance As IUADataTypeSystem
Dim dataTypeDescriptor As UADataTypeDescriptor
Dim genericData As GenericData
Dim value As ValueResult
 
value = instance.EncodeInDataTypeDictionaryModel(dataTypeDescriptor, genericData)
[NotNull()]
ValueResult EncodeInDataTypeDictionaryModel( 
   UADataTypeDescriptor dataTypeDescriptor,
   GenericData genericData
)
[NotNull()]
ValueResult^ EncodeInDataTypeDictionaryModel( 
   UADataTypeDescriptor^ dataTypeDescriptor,
   GenericData^ genericData
) 

Parameters

dataTypeDescriptor
Identifies an OPC UA data type together with its data type dictionary.

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

genericData
The generic data to be encoded.

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

Return Value

A value result: A success with the encoded extension object body, or a failure.

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

Remarks

The data type dictionary in the data type descriptor dataTypeDescriptor must refer to a dictionary that is known in the data type system (either intrinsically, by configuration, or added through the AddDataTypeDictionary method). The data type description in the dataTypeDescriptor must be valid and exist in the data type dictionary.

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