FindDataTypeDescriptions Method (UAHeaderDataTypeSchema)

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overrides Function FindDataTypeDescriptions( _
   ByVal dataTypeIdList As IReadOnlyList(Of UANodeId), _
   ByVal searchSupertypes As Boolean _
) As ValueResult(Of UADataTypeDescription)()

'Usage
 
Dim instance As UAHeaderDataTypeSchema
Dim dataTypeIdList As IReadOnlyList(Of UANodeId)
Dim searchSupertypes As Boolean
Dim value() As ValueResult(Of UADataTypeDescription)
 
value = instance.FindDataTypeDescriptions(dataTypeIdList, searchSupertypes)

public override ValueResult<UADataTypeDescription>[] FindDataTypeDescriptions( 
   IReadOnlyList<UANodeId> dataTypeIdList,
   bool searchSupertypes
)

public:
array<ValueResult<UADataTypeDescription^>^>^ FindDataTypeDescriptions( 
   IReadOnlyList<UANodeId^>^ dataTypeIdList,
   bool searchSupertypes
) override

Parameters

dataTypeIdList: List of data type IDs.List of data type IDs.
searchSupertypes: Determines whether supertypes will be searched into.Determines whether supertypes will be searched into.

Return Value

Returns an array of value results containing data type descriptions for each data type ID in the input list.Returns an array of value results containing data type descriptions for each data type ID in the input list.

A succeeded value result element (in the returned sequence) with null in the Value denotes that the DataTypeDefinition model is not available for the given data type ID.

This is a multiple-operation method. In a properly written program, it does not throw any exceptions. You should therefore not put try/catch statements or similar constructs around calls to this method. The only exceptions thrown by this method are for usage errors, i.e. when your code violates the usage contract of the method, such as passing in invalid arguments or calling the method when the state of the object does not allow it. Any operation-related errors (i.e. errors that depend on external conditions that your code cannot reliably check) are indicated in the result objects returned by the method. For more information, see Multiple-operation Methods and Do not catch any exceptions with asynchronous or multiple-operation methods.

A succeeded value result element (in the returned sequence) with null in the Value denotes that the DataTypeDefinition model is not available for the given data type ID.

This is a multiple-operation method. In a properly written program, it does not throw any exceptions. You should therefore not put try/catch statements or similar constructs around calls to this method. The only exceptions thrown by this method are for usage errors, i.e. when your code violates the usage contract of the method, such as passing in invalid arguments or calling the method when the state of the object does not allow it. Any operation-related errors (i.e. errors that depend on external conditions that your code cannot reliably check) are indicated in the result objects returned by the method. For more information, see Multiple-operation Methods and Do not catch any exceptions with asynchronous or multiple-operation methods.

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

Reference

UAHeaderDataTypeSchema Class
UAHeaderDataTypeSchema Members
Base Implementation in FindDataTypeDescriptions