system.project.requestScan
This function is used in Python Scripting.
Description​
Requests a manual scan of the projects directory in order to refresh projects and their resources. If a scan is currently running, this method has no effect and will return when the in-progress scan has finished. This function blocks the current thread until a scan has completed.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax​
system.project.requestScan([timeout])
Parameters​
Type | Parameter | Description |
---|---|---|
Integer | timeout | The amount of time, in seconds, to block the current thread before timing out. Default is 10 seconds. [optional] |
Returns​
None
Scope​
Gateway, Perspective Session
Code Example​
Code Snippet
# This example requests a manual scan of the project directory
# while blocking the current thread for 30 seconds before timing out.
system.project.requestScan(30)