cwbOBJ_OpenSplF

Purpose

Opens an iSeries™ spooled file for reading.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_OpenSplF(
                               cwbOBJ_ObjHandle  splFHandle,
                               cwbSV_ErrHandle   errorHandle);

Parameters

cwbOBJ_ObjHandle splFHandle - input

Handle of the spooled file to be opened for reading.

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 spooled file should be closed with the cwbOBJ_CloseSplF() API when done reading from it.