OPC Studio User's Guide and Reference
FindByDecimalValue Method (_EnumerationDataType)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.DataTypeModel.ComTypes Namespace > _EnumerationDataType Interface : FindByDecimalValue Method
The enumeration value to be found.

Valid values of this parameter are in the range from -9223372036854775808 (Int64.MinValue) to 9223372036854775807 (Int64.MaxValue).

Finds an enumeration member by its value.
Syntax
'Declaration
 
<CanBeNullAttribute()>
Function FindByDecimalValue( _
   ByVal value As Decimal _
) As EnumerationMember
'Usage
 
Dim instance As _EnumerationDataType
Dim value As Decimal
Dim value As EnumerationMember
 
value = instance.FindByDecimalValue(value)
[CanBeNull()]
EnumerationMember FindByDecimalValue( 
   decimal value
)
[CanBeNull()]
EnumerationMember^ FindByDecimalValue( 
   decimal value
) 

Parameters

value
The enumeration value to be found.

Valid values of this parameter are in the range from -9223372036854775808 (Int64.MinValue) to 9223372036854775807 (Int64.MaxValue).

Return Value

Returns an OpcLabs.BaseLib.DataTypeModel.EnumerationMember which has the value given by the value parameter. When there is no such enumeration member, the function returns a null reference. When there is more than one match, the first matching enumeration member found is returned.

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

Remarks

This member is not compatible with VBScript.

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

For finding an enumeration value that corresponds to given name, use the fact that EnumerationMembers is a collection keyed by the enumeration member names.

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