Cicode Programming Reference > Cicode Function Categories > Page Functions > PageSetStr

PageSetStr

Stores a local page-based string and associates the string with the page. Page-based variables are stored in an array, local to each display page. This function allows you to save string variables in temporary storage.

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

PageSetStr(sLabel, sVar [, iWinNum])

sLabel:

String name of the variable which will contain sVar.

sVar:

The string to store. The string length is 128 characters.

iWinNum:

Window number of the page. Default is current window.

Return Value

No error(0) on success. 269 if WinNum handle does not correspond to a valid window. 274 if Label or Var is not a valid variable.

Related Functions

PageGetInt, PageGetStr, PageSetInt

See Also

Page Functions

Published June 2018