Sets or retrieves the description attached to the active CitectSCADA graphics page.
Syntax
PageDescription(Description)
Description:
The description applied to the active graphics page, as a string.
Return Value
The description of the active graphics page as a string, or 0 (zero) if successfully used to apply a description to the active graphics page. In both cases, an error is returned if unsuccessful.
Note: For details on handling return and error values, see Error Handling.
Related Functions
PageName, PageTitle, PagePrevious, ProjectNext, PageScanTime, PageLogDevice, PageNext, PageArea
See Also
Example
' Attaches a description to the active graphics page
GraphicsBuilder.PageDescription = "MyDescription"
' Retrieves the description for the active graphics page
MyVariable = GraphicsBuilder.PageDescription
Note: This function is implemented in the
C++ environment as two separate functions: put_PageDescription sets the title of the
active graphics page, and get_PageDescription retrieves the title of the
active graphics page.