Purge the Data Buffer

Program-to-Program Interface › Control Data Buffers › Purge the Data Buffer

Purge the Data Buffer

To allow the caller to purge the front buffer on a receiver queue, use request code 23. It is equivalent to receiving the buffer and ignoring it, except that no receiver buffer is needed, which is useful for purging buffers that are too long.

The RPB fields in the following table must be set up before the call:

Bytes	Field Name	Set to...
00–03	RPLEN	56.
04–05	REQUEST	23.
06–07	RECOPT	A recovery option as required.
12–15	WORKADDR	The address of a 128-byte work area.
16–19	ASCBADDR	The address of the current ASCB.
24–31	RECVERID	The target receiver ID.

The RPB field in the following table is returned after the call:

Bytes	Field Name	Set to...
08–11	RETCODE	The return code.

The following return codes are possible:

0: Request completed successfully—the front data buffer has been purged.
22: The requestor is not in primary addressing mode.
24: PPI is not active.
25: The ASCB address is not correct.
26: The receiver program is not defined.
28: PPI requests are not supported.
30: No data buffers are in the receiver buffer queue.
36: ESTAE could not be established as requested.
40: Sender ID is invalid.
90: A processing error occurred.

Notes:

The correct ASCB address is required-that is, the ASCB address provided when the receiver was defined.
Only one data buffer at a time can be purged.
If no buffers are queued, return code 30 is returned.

Tell Technical Publications how we can improve this information