GetScrInfo

The function GetScrInfo gets information about an open project screen.

Syntax

GetScrInfo(strScreenName,"tagResult",optNumResultType,optNumID)

strScreenName

The name of the screen about which you want to get information.

tagResult

The name of the project tag that will receive the information.

Note: If this parameter is enclosed in quotes, the string literal will be used. Otherwise, the value of the tag/expression will be used.

optNumResultType

A numeric flag specifying the type of information to be retrieved by the function:

This is an optional parameter; the default value is 0.

optNumID

The specific instance number of the screen. (The ID is assigned when the screen is opened with the function Open.) This is an optional parameter; the default ID is 0.

Returned value

This function returns one of the following possible values:

Notes

If the Enforce Web functionality equivalence in local project screens option is selected in the project settings, this function cannot be called in VBScript Global Procedures, VBScript scripts (script groups), or other background tasks. This is because the function behaves differently depending on whether you view project screens locally (that is, on the same computer that hosts the project runtime) or remotely. For more information, see Preferences tab.

Examples

Retrieve the TOP, LEFT, BOTTOM and RIGHT coordinates of the "main" screen and then write them to the first four positions of the array tag TagXY:

GetScrInfo("main","TagXY[0]")

Retrieve the BOTTOM coordinate of the "main" screen and then write it to TagXY:

GetScrInfo("main","TagXY",3)

Retrieve the LEFT coordinate of the "main" screen with ID 10 and then write it to TagXY:

GetScrInfo("main","TagXY",2,10)