BKM QUERYTABTEXT

This message queries the text, text size, or both for the specified page.

Syntax

param1
ULONG ulPageId;   /* Page ID. */

param2
PBOOKTEXT pBookText; /* Pointer to a BOOKTEXT data structure. */

Parameters

ulPageId (ULONG) - Input

Page identifier of the page whose tab text is requested. This should be a page for which a BKA_MAJOR or BKA_MINOR attribute has been specified.

pBookText (PBOOKTEXT) - Input/Output

Pointer to a BOOKTEXT data structure.

Returns

tabTextLen (USHORT) - returns

Length of the tab text string:

BOOKERR_INVALID_PARAMETERS: An invalid page ID was specified for the ulPageId parameter or the structure specified for the pBookText parameter is invalid.

0: No text data has been set (BKM_SETTABTEXT) for the page specified in the ulPageId parameter.

Other: Length of the returned tab text string.

Remarks

The size of the tab text string can be queried by specifying 0 for the tabTextLen field in the BOOKTEXT data structure. In this way, the application can determine the size of the buffer needed to store the tab text string. The null character at the end of the text string is not included in the returned length.

If this message is sent for a page having both major and minor tab attributes, the notebook returns the text which is associated with the major tab.

Default Processing

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