Cicode Programming Reference > Cicode Function Categories > Page Functions Introduction > PageGetStr

PageGetStr

Gets the string associated with a variable name on a particular page. Page-based variables are local to each display page. If two or more windows are displayed, each window has a unique copy of the variable. You can use these variables in Cicode to keep track of variables unique to each window.

Note: This function is not supported in the server process in a multiprocessor environment. Calling this function from the server process results in a hardware alarm being raised.

Syntax

PageGetStr(sLabel [, iWinNum])

sLabel:

String name of the variable to return

iWinNum:

Window number of the page. Default is current window.

Return Value

Value stored in variable sLabel.

Related Functions

PageSetInt, PageGetInt, PageSetStr

See Also

Page Functions