System Projects Reference > Situational Awareness System Projects > Situational Awareness Include Project > Workspace_IsSelContext

Workspace_IsSelContext

Checks if an equipment name is the selected context of the workspace on the current page.

Syntax

Workspace_IsSelContext(STRING sEquipmentName, STRING sSecondaryEquipmentName)

sEquipmentName

Name of a piece of equipment.

sSecondaryEquipmentName

The value of the equipment name that is set as the secondary context for related equipment. For example, for a Polar Star Composite Genie, this will be the value specified in the Equipment Name option in the Presentation Options dialog box. This is used to determine the number of symbols to be displayed for MEOs.

Return Value

Returns TRUE if equipment is the selected context. Otherwise returns FALSE.

Example

IF Workspace_IsSelContext(DspAnGetMetadata(KeyGetCursor(),"EquipmentName")) THEN
Workspace_RightClickEquipment(DspAnGetMetadata(KeyGetCursor(),"EquipmentName"))
END

Related Functions

Published June 2018