CWBSO_SetListTitle

Purpose

Sets the title for a list. The title is displayed in the title bar of the window when the list is displayed by a call to CWBSO_DisplayList.

Syntax

 
unsigned int CWB_ENTRY CWBSO_SetListTitle(
                CWBSO_LIST_HANDLE listHandle ,          
                char far* lpszTitle);                   

Parameters

CWBSO_LIST_HANDLE listHandle - input

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

char far* lpszTitle - input

A long pointer to a string to be used for the list title. The length of the string must be less than or equal to 79.

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_TITLE

The title 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.