ADDIDLEPROC Method (System)
Description
The Presentation Server can maintain a list of stored procedures (the "IDLEPROC queue") 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".
The method appends a procedure and its associated data to the end of this queue.
Syntax
SuccessFlag = Exec_Method( "SYSTEM",
"ADDIDLEPROC",
ProcName,
Parameter,
ExecTime,
ExecDate )
Parameters
| Name | Required | Description |
|---|---|---|
| ProcName | Yes | Name of the stored procedure to add to the queue. |
| Parameter | No | Parameter to pass to the stored procedure when it is executed. |
| ExecTime | No | Local time that the stored procedure should be executed, in the format "hh:mm:ss". If this is not specified the stored procedure will be executed when as the Presentation Server is idle. |
| ExecDate | No | Local date that the stored procedure should be executed, in the format "mm/dd/yy". |
Returns
Returns TRUE$ if the item was added to the successfully, or FALSE$ otherwise.
Remarks
The contents of the queue can be examined via the IDLEPROCQUEUE property.
Example
// Example - add a request to the IDLEPROC queue:
//
// Execute a stored procedure called MYPROC, passing it
// a parameter of "DoStuff" and execute it at midday
IsAdded = Exec_Method( "SYSTEM", "IDLEPROC",
"MYPROC",
"DoStuff",
"12:00:00",
"" )
See Also
IDLEPROC property, IDLEPROCQUEUE method, Common GUI TIMER event.