BKM SETTABTEXT

This message associates a text string with the specified page.

Syntax

param1
    ULONG ulPageId; /* Page ID. */

param2
    PSZ   pString;  /* Pointer to a text string that ends with a null character. */

Parameters

ulPageId (ULONG) - input

The page identifier with which to associate the text string. This should be a page for which a BKA_MAJOR or BKA_MINOR attribute has been specified.

pString (PSZ) - input

Pointer to a text string that ends with a null character.

Returns

rc (BOOL) - returns

Success indicator.

TRUE: Tab text was successfully set.

FALSE: Unable to set tab text. If the page ID specified in the ulPageId parameter is invalid or if it identifies a page that does not have a BKA_MAJOR or BKA_MINOR attribute, FALSE is returned and no text string is associated with the page.

Remarks

The text is centered from the tab edges. The application can define a mnemonic key when sending this message by placing a tilde (~) character before the character that is to be the mnemonic key. The notebook brings this page to the top whenever the user presses the mnemonic key. The mnemonic key processing is not case-sensitive, so the user can type the mnemonic character in either upper or lower case. The application can remove or change the mnemonic key by sending additional BKM_SETTABTEXT messages for the specified page. If this message is sent for a page having both major and minor tab attributes, the notebook sets both the major and minor tab text.

Default Processing

The default window procedure does not expect to receive this message and therefore takes no action on it other than to return FALSE.