cwbOBJ_HoldSplF

Use the cwbOBJ_HoldSplF API with this product.

Purpose

Holds a spooled file.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_HoldSplF(
                               cwbOBJ_ObjHandle    splFHandle,
                               cwbOBJ_ParmHandle  *parmListHandle,
                               cwbSV_ErrHandle     errorHandle);

Parameters

cwbOBJ_ObjHandle splFHandle - input: Handle of the spooled file to be held.
cwbOBJ_ParmHandle *parmListHandle - input: Optional. A pointer to a valid parameter list object handle that contains parameters for holding the spooled file.
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 valid.
CWB_INVALID_PARAMETER: Invalid parameter specified.
CWBOBJ_RC_HOST_ERROR: Host error occurred. Text may be in errorHandle.
CWBOBJ_RC_INVALID_TYPE: Handle is not a spooled file handle.

Usage

The following parameter key may be set in the parmListHandle object:

CWBOBJ_KEY_HOLDTYPE
what type of hold to do. May be "*IMMED" or "*PAGEEND". "*IMMED" is the default.