IDLEPROC property (System)
Description
The Presentation Server can maintain a list of stored procedures that can be executed when the system is "idle" (i.e. there are no other Events or Basic+ stored procedures to execute), or at a specific time and date. These are referred to as "idle procedures".
This property returns details of the first item waiting the in the "idle procedure" queue, or replaces the entire queue with the details for a single procedure to execute instead.
Property Value
This property is an @fm-delimited array containing the queued "idle procedure" name and associated data in the following format:
<0,1> Procedure Name
<0,2> Parameter Value – can be null
<0,3> Execution Time (local time in the format hh:mm:ss) – can be null
<0,4> Execution Date (in the format mm/dd/yy) – can be null
If the time is null then then procedure will be executed as soon as the Presentation Server is idle. If the date is null then the current date is used as a default value.
Setting the Procedure Name to null will clear the IDLEPROC queue.
Property Traits
Development | Runtime | Indexed | Scaled | Synthetic |
---|---|---|---|---|
N/A | Get | No | No | No |
Remarks
This property is deprecated and implemented for backwards compatibility only. New applications should use the ADDIDLEPROC method instead, thereby preserving the queue contents when adding a new item.
Example
// Example - Clear the IDEPROC Queue Call Set_Property_Only( "SYSTEM", "IDLEPROC", "" ) // Example - Replace the "idle procedure" queue with a new value IDP = "" IDP<1> = "MYPROC" ; // Procedure Name IDP<2> = "DoStuff" ; // Parameter to pass to "MYPROC" IDP<3> = "12:00:00" ; // Execute at midday IDP<4> = "" ; // Execute today Call Set_Property_Only( "SYSTEM", "IDLEPROC", IDP )
See Also
IDLEPROC property, ADDIDLEPROC method, Common GUI TIMER event.