GetEnumValue

Get ordinal value for enumerated type by name

Declaration

Source position: typinfo.pp line 987

  function GetEnumValue(TypeInfo: PTypeInfo; const Name: string) : Integer;

Description

GetEnumValue scans the type information for the enumeration type described by TypeInfo and returns the ordinal value for the element in the enumerated type that has identifier Name. The identifier is searched in a case-insensitive manner.

This can be used to set the value of enumerated properties from a stream.

For an example, see GetEnumName .

Errors

If Name is not found in the list of enumerated values, then -1 is returned. No check is done whether TypeInfo points to the type information for an enumerated type.

See also