PageScanTime

Retrieves or sets the PageScanTime property for the current graphics page.

Syntax

PageScanTime(ScanTime)

ScanTime:

A value between 1 and 60000 as a string, or blank to set to default.

Return Value

If retrieving the current PageScanTime setting, the value returned is between 1 and 60000 as a string, or a blank string if set to default.

If you are using the function to apply a ScanTime setting, 0 (zero) is returned if successful, or an E_INVALIDARG error if the value you want to apply is out of range.

Note: For details on handling return and error values, see Error Handling.

Related Functions

PageName, PageTitle, PageDescription, PagePrevious, PageNext, PageLogDevice

Example

' Assigns a ScanTime value to the current graphics page

GraphicsBuilder.PageScanTime = "2000"

' Retrieves the ScanTime setting for the current page

MyVariable = GraphicsBuilder.PageScanTime

Note: This function is implemented in the C++ environment as two separate functions: put_PageScanTime applies an ScanTime setting to active graphics page, and get_PageScanTime retrieves the current ScanTime setting.

See Also

Page Properties - General