PageSetInt

Associates an integer variable with a particular page. Page-based variables are stored in an array, local to each display page. This function allows you to save integer variables in temporary storage.

Notes

• You can dynamically change the setting for [Page]ScanTime parameter, by calling this function as follows: PageSetInt(-2, <scantime>).
• 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

PageSetInt(sLabel, sVar [, iWinNum])

sLabel:

String name of the variable which will contain sValue.

sVar:

The integer to store.

iWinNum:

Window number of the page. Default is current window.

Return Value

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

Related Functions

PageGetInt, PageGetStr, PageSetStr

See Also

Page Functions