|
The wait function checks the status of the host-connected presentation space. If the session is waiting for a host response, the wait function causes hllapi.js to wait up to 1 minute to see if the condition clears.
Prerequisite Calls
connectPresentationSpace
Call Parameters
Parameter name
|
Explanation
|
success
|
A callback function parameter that gets executed if the session is not currently waiting for a host response.
|
failed
|
A callback function parameter that gets executed when the 1 minute time-out has elapsed.
|
Return Properties
Property name
|
Explanation
|
returnCode
|
A numeric code indicating the execution status of the function. Please refer to the Return Code table below for all possible values.
|
Return Code
The following values are defined for the 'returnCode' property:
Return Code
|
Explanation
|
0
|
The wait function was successful.
|
1
|
Your program is not connected to a host session.
|
Remarks
| 1. | This function is equivalent to HLLAPI Function Number 4. |
|