Workspace_SetContext

Sets the context of the current workspace to the specified piece of equipment.

Syntax

Workspace_SetContext(STRING sEquipmentName, INT bIncludeCurrentPane, STRING sEquipmentSecondaryContext, STRING sWorkspaceName)

sEquipmentName

Name of a piece of equipment.

bIncludeCurrentPane

Allow the current page to be automatically filled and context updated. This may result in the page that you clicked on changing. Default = FALSE. This is an optional parameter.

sWorkspaceName

Name of the workspace for which to set the context.

sEquipmentSecondaryContext

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

N/A

Related Functions

Workspace_GetContext, Workspace_GetEquipmentCluster, Workspace_GetPageNameWithRes, Workspace_GetResolution, Workspace_GetSelContext, Workspace_GetWindow, Workspace_GetWorkspaceFromName, Workspace_GetWorkspaceFromWindow, Workspace_Init, Workspace_IsSelContext, Workspace_IsSystem_Initialised, Workspace_SelectEquipment, Workspace_SetSelContext, Workspace_ShowContent

See Also

Public Functions