CWBSO_CloseList

Purpose

Closes the list of objects and frees up resources allocated on the iSeries™ server.

Syntax

 
unsigned int CWB_ENTRY CWBSO_CloseList(
                CWBSO_LIST_HANDLE listHandle,           
                CWBSO_ERR_HANDLE errorHandle);          

Parameters

CWBSO_LIST_HANDLE listHandle - input

A handle to a list that was returned by a previous call to CWBSO_CreateListHandle or CWBSO_CreateListHandleEx.

CWBSO_ERR_HANDLE errorHandle - input

A handle to an error that was returned by a previous call to CWBSO_CreateErrorHandle. When the value that is returned by this API is CWBSO_ERROR_OCCURRED, the error handle may be used to retrieve the error message text or display the error to the user.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR

No error occurred.

CWBSO_BAD_LIST_HANDLE

The list handle that is specified is not valid.

CWBSO_BAD_ERR_HANDLE

The error handle that is specified is not valid.

CWBSO_ERROR_OCCURRED

An error occurred. Use the error handle for more information.

CWBSO_LOW_MEMORY

Not enough memory is available for the request.

Usage

CWBSO_CreateListHandle must be called prior to calling this API. The list handle that is returned by CWBSO_CreateListHandle must be passed as input to this API. CWBSO_CreateErrorHandle must be called prior to calling this API. The error handle that is returned by CWBSO_CreateErrorHandle must be passed as input to this API. The list must currently be open. The list is opened by calling CWBSO_OpenList. This API will not end the conversation with the iSeries server. For the conversation to be ended the list must be deleted using CWBSO_DeleteListHandle.