SLI_PURGE
This verb purges an outstanding SLI_RECEIVE. SLI_PURGE might be needed by an application program that uses an SLI_RECEIVE verb with the WAIT option. For example, if the SLI_RECEIVE verb does not complete in a specified interval of time, the application program can issue SLI_PURGE. The application program supplies the address of the SLI_RECEIVE verb control block in the lua_data_ptr parameter to specify which SLI_RECEIVE to purge.
Supplied Parameters
The application supplies the following parameters:
- lua_verb
- LUA_VERB_SLI
The verb-code indicator for the LUA verbs.
- lua_verb_length
- The length of the verb control block. This number must equal the length expected by the SLI for the SLI_PURGE verb.
- lua_opcode
- LUA_OPCODE_SLI_PURGE
The operation code for the verb.
- lua_correlator
- A value that an LUA application program can supply to help correlate this verb with other information that the program supplies. This parameter is ignored by the LUA interface.
- lua_luname
- The local LU name in ASCII. If the name contains fewer than 8 characters, you must pad it with blanks. LUA examines this parameter only if lua_sid is 0. Using the lua_luname parameter on all verbs helps make debugging easier, especially when multiple LUs are configured.
- lua_sid
- The session ID, returned by SLI_OPEN, that identifies the session to be used. If this parameter is 0, the lua_luname parameter is used for identification.
- lua_data_ptr
-
A pointer to the application program SLI_RECEIVE verb control block to be purged.
- lua_post_handle
- If asynchronous notification is to be accomplished by events, lua_post_handle contains the handle of the event to be signaled.
Returned Parameters
If the verb completes successfully, the following parameters are returned:
- lua_flag2.async
- A flag that indicates that this verb completes asynchronously.
- lua_prim_rc
- The primary return code, set by the verb function. For details, see LUA Verb Return Codes.
- lua_sec_rc
- The secondary return code, set by the verb function. For details, see LUA Verb Return Codes.
Usage Notes
If SLI_RECEIVE is purged successfully, SLI_RECEIVE ends with the CANCELED primary return code and the SLI_PURGE completes with the OK primary return code.