system.vision.getReadTimeout

Backwards Compatibility

This function replaces system.util.getReadTimeout. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description

Returns the read timeout in milliseconds for all client-to-gateway communication. This is the maximum amount of time allowed for a communication operation to complete. The default is 60,000ms (1 minute).

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.getReadTimeout()

Parameters

Nothing

Returns

Integer - The current read timeout, in milliseconds. Default is 60,000 (one minute)

Scope

Vision Client

Code Examples

Example #1

# This code will find the current read timeout and write it to a numeric text field on the same page.
 
event.source.parent.getComponent('Numeric Text Field').intValue = system.vision.getReadTimeout()