cwbOBJ_CloseNewSplFAndGetHandle

Purpose

Closes a newly created spooled file and returns a handle to it.

Syntax

 
unsigned int CWB_ENTRY cwbOBJ_CloseNewSplFAndGetHandle(
                              cwbOBJ_ObjHandle      newSplFHandle,
                              cwbOBJ_ObjHandle     *splFHandle,
                              cwbSV_ErrHandle       errorHandle);

Parameters

cwbOBJ_ObjHandle newSplFHandle - input

New spooled file handle. This is the handle passed back on the cwbOBJ_CreateNewSplF() API.

cwbOBJ_ObjHandle *splFHandle - output

Pointer to an object handle that, upon successful, completion of this call, will hold the spooled file handle. This handle may be used with other APIs that take a spooled file handle as input.

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 spooled file handle.

CWBOBJ_RC_HOST_ERROR

Host error occurred. Text may be in errorHandle.

Usage

The handle returned in splFHandle must be released with the cwbOBJ_DeleteObjHandle() API in order to free resources.