CWBSO_WriteListProfile

Purpose

Writes the filter information for the list to the specified key in the Windows^® registry. The key name must previously have been set using the CWBSO_SetListProfile API. This API should be called before deleting the list. This will save any filter criteria that was changed by the user during the CWBSO_DisplayList API. Filter information is saved in the registry by iSeries™ system and by type of list. For example, if your application accesses objects from two different iSeries systems, and displays all four types of lists, you would have eight different sections in the registry that specify filter information.

Syntax

 
unsigned int CWB_ENTRY CWBSO_WriteListProfile(
                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 object that was created 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_SYSTEM_NAME_DEFAULTED

No system name was specified on the CWBSO_CreateListHandle call for the list.

CWBSO_LOW_MEMORY

Not enough memory is available for the request.

CWBSO_ERROR_OCCURRED

An error occurred. Use the error for more information.

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_SetListProfile must be called prior to calling this API.