cwbOBJ_HoldOutputQueue

Use the cwbOBJ_HoldOutputQueue API with this product.

Purpose

Holds an IBM i output queue.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_HoldOutputQueue(
                               cwbOBJ_ObjHandle  queueHandle,
                               cwbSV_ErrHandle   errorHandle);

Parameters

cwbOBJ_ObjHandle queueHandle - input: Handle of the output queue to be held.
cwbSV_ErrHandle errorHandle - output: Optional, may be 0. 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 retrievable.

Return Codes

The following list shows common return values.

CWB_OK: Successful completion.
CWB_NOT_ENOUGH_MEMORY: Insufficient memory.
CWB_INVALID_HANDLE: Handle is not a valid queue handle.
CWBOBJ_RC_HOST_ERROR: Host error occurred. Text may be in errorHandle.

Usage

None