[ Previous | Next | Contents | Search ]
3270 Host Connection Program 2.1 and 1.3.3 for AIX: Guide and Reference

WAIT (4)

Purpose

Checks the status of the host presentation space (PS).

Prerequisite Calls

This function requires a prerequisite call to the CONNECT PRESENTATION SPACE (1) function.

Syntax

hllc (func, apistring, len, ret)
int *func;
char *apistring;
int *len;
int *ret;

Supplied Parameters

Supply the following parameters to invoke the WAIT function:

func Specifies the number of the function called; must be a 4 for the WAIT function.
apistring Does not apply for this function.
len Does not apply for this function.
ret Does not apply for this function.

Returned Parameters

ret The following codes are valid:
0 Specifies that the keyboard was unlocked and ready for input.
1 Specifies that your application program was not connected to a valid session.
4 Specifies a time-out while still busy (in XCLOCK or XSYSTEM in X) for the 3270 terminal emulation.
5 Specifies that the keyboard is locked.
9 Specifies that a system error occurred.

Remarks

If the controller or host system is busy, the WAIT function causes HLLAPI to wait for a specified time to see if the condition clears. The specified time is determined by options in the SET SESSION PARAMETERS (9) function.

The WAIT function checks the status of the host PS. If the controller or host system is busy, the WAIT function causes HLLAPI to wait for a specified time to see if the condition clears. The WAIT function gives functions such as the SEND KEY (3) function enough time to complete. Use the SET SESSION PARAMETERS (9) function to request the TWAIT, LWAIT, or the NWAIT option. Each option determines a specified amount of time that the WAIT function uses.

When the return code is 0 and the keyboard unlocks, the WAIT function has been executed. However, the original transaction may not have been completed. Use the SEARCH FIELD (30) function, or the SEARCH PRESENTATION SPACE (6) function combined with the WAIT function, to look for expected keyword prompts.

The WAIT function determines if the host Operator Information Area (OIA) is inhibited.

Note: The 3270 terminal emulation sessions wait until a host response occurs; the response is indicated when an XSYSTEM or X is turned off in the OIA.

Related Information

CONNECT PRESENTATION SPACE (1) function , SEARCH FIELD (30) function , SEARCH PRESENTATION SPACE (6) function , SEND KEY (3) function and SET SESSION PARAMETERS (9) function .

[ Previous | Next | Contents | Search ]