AlarmIndicatorGetFlagLocation

Retrieves the position of the flag for the Alarm Indicator.

Syntax

AlarmIndicatorGetFlagLocation

Return Value

0 to 7

The position is outlined below:

• 0 - Top Left

• 1 - Center Left

• 2 - Bottom Left

• 3 - Top Center

• 4 - Bottom Center

• 5 - Top Right

• 6 - Middle Right

• 7 - Bottom Right

Note: For details on handling return and error values, see Error Handling.

Related Functions

AlarmIndicatorGetBorderIsInside, AlarmIndicatorGetBorderPadding, AlarmIndicatorGetBorderWidth, AlarmIndicatorGetEnabled, AlarmIndicatorGetEquipHierarchy, AlarmIndicatorGetExpr, AlarmIndicatorGetFlagEnabled, AlarmIndicatorGetFrameColor, AlarmIndicatorGetInclude, AlarmIndicatorSetBorderIsInside, AlarmIndicatorSetBorderPadding, AlarmIndicatorSetBorderWidth, AlarmIndicatorSetEnabled, AlarmIndicatorSetEquipHierarchy, AlarmIndicatorSetExpr, AlarmIndicatorSetFlagEnabled, AlarmIndicatorSetFlagLocation, AlarmIndicatorSetFrameColor, AlarmIndicatorSetInclude

Example

iFlagLocationGet= gb2.AlarmIndicatorGetFlagLocation;