BKM QUERYSTATUSLINETEXT

This message queries the status line 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 status line text is requested.

pBookText (PBOOKTEXT) - Input/Output

Pointer to a BOOKTEXT data structure.

Returns

statusTextLen (USHORT) - returns

Length of the status line 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_SETSTATUSLINETEXT) for the page specified in the ulPageId parameter.

Other: Length of the returned status line text string.

Remarks

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

Default Processing

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