Workspace_GetPageNameWithRes

If you are using multiple resolutions in your project, this function can be used to return an adjusted page name matching your workspace resolution. If a page does exist in your project matching the resolution, then the original name will be returned.

Your pages need to be named "<PageName>_HD1080" or "<PageName>_UHD4K".

For example if your project supports HD1080 and UHD4K, and you have designed variations of your page for each resolution: "Test_HD1080" and "Test_UHD4K", then call this function with the page name "Test". .

This is BLOCKING function.

Syntax

Workspace_GetPageNameWithRes(STRING sPage [, STRING sWorkspaceName])

sPage

Name of the page.

sWorkspaceName

Name of the workspace to which the page belongs. This is an optional parameter. The default value is "", which uses the workspace of the current window.

Return Value

Returns the adjusted page name or the original passed in name if a page is not found matching the workspace resolution.

Related Functions

Workspace_GetContext, Workspace_GetEquipmentCluster, 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