cwbOBJ_PurgeOutputQueue

Purpose

Purges spooled files on an iSeries™ output queue.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_PurgeOutputQueue(
                               cwbOBJ_ObjHandle    queueHandle,
                               cwbOBJ_ParmHandle  *parmListHandle,
                               cwbSV_ErrHandle     errorHandle);

Parameters

cwbOBJ_ObjHandle queueHandle - input

Handle of the output queue to be purged.

cwbOBJ_ParmHandle * parmListHandle - input

Optional. A pointer to a valid parameter list object handle that contains parameters for purging the output queue.

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_NO_ERROR

Successful completion.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory.

CWB_INVALID_HANDLE

Handle is not valid.

CWB_INVALID_PARAMETER

Invalid parameter specified.

CWBOBJ_RC_HOST_ERROR

Host error occurred. Text may be in errorHandle.

Usage

The parameters specified in parmListHandle, if provided, will specify which spooled files are purged. If parmListHandle is NULL, all spooled files for the current user are purged. The following parameter key's may be set in the parmListHandle object:

• CWBOBJ_KEY_USER

  which user's spooled files to purge. May be a specific user ID, "*ALL" or "*CURRENT". "*CURRENT" is the default.

• CWBOBJ_KEY_FORMTYPE

  which spooled files to purge base on what formtype they have. May be a specific formtype, "*ALL" or "*STD". "*ALL" is the default.

• CWBOBJ_KEY_USERDATA

  which spooled files to purge base on what userdata they have. May be a specific value or "*ALL". "*ALL" is the default.