CWBSO_SetListProfile

Purpose

Sets the profile name by adding the application name into the Windows^® Registry. Use CWBSO_ReadListProfile to read the filter information from the Registry prior to displaying a list. Use CWBSO_WriteListProfile to write the updated filter information to the Registry before deleting the list. If this API is not called, CWBSO_ReadListProfile and CWBSO_WriteListProfile will have no effect.

Syntax

 
unsigned int CWB_ENTRY CWBSO_SetListProfile(
                CWBSO_LIST_HANDLE listHandle,           
                char far* lpszKey);                     

Parameters

CWBSO_LIST_HANDLE listHandle - input

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

char far* lpszKey - input

A long pointer to a string that will be used as the key in the Windows Registry for the list. This name could be the name of the application.

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_PROFILE_NAME

The profile name that is specified is not valid.

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.