cwbOBJ_CloseNewSplF

Use the cwbOBJ_CloseNewSplF API with this product.

Purpose

Closes a newly created spooled file.

Syntax

 
unsigned int CWB_ENTRY cwbOBJ_CloseNewSplF(
                              cwbOBJ_ObjHandle   newSplFHandle,
                              cwbSV_ErrHandle    errorHandle);

Parameters

cwbOBJ_ObjHandle newSplFHandle - input: New spooled file handle. This is the handle passed back on the cwbOBJ_CreateNewSplF() API.
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 spooled file handle.
CWBOBJ_RC_HOST_ERROR: Host error occurred. Text may be in errorHandle.

Usage

Once a spooled file is closed, you can no longer write to it.