cwbDQ_Cancel

Purpose

Cancel a previously issued AsyncRead. This will end the read on the iSeries™ data queue.

Syntax

 
unsigned int CWB_ENTRY cwbDQ_Cancel(
                             cwbDQ_ReadHandle    readHandle,
                             cwbSV_ErrHandle     errorHandle);

Parameters

cwbDQ_ReadHandle readHandle - input

The handle that was returned by the AsyncRead API.

cwbSV_ErrHandle errorHandle - output

Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle API. The messages may be retrieved through the cwbSV_GetErrText API. If the parameter is set to zero, no messages will be retrieved.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWBDQ_INVALID_READ_HANDLE

Invalid read handle.

Usage

This function requires that you have previously issued the following APIs:

• cwbDQ_Open or cwbDQ_OpenEx
• cwbDQ_CreateData
• cwbDQ_AsyncRead