BKM SETSTATUSLINETEXT

This message associates a text string with the specified page's status line.

Syntax

param1
ULONG ulPageId; /* Page ID. */

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

Parameters

ulPageId (ULONG) - Input

The page identifier with which to associate the text string.

pString (PSZ) - Input

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

Returns

rc (BOOL) - returns

Success indicator:

TRUE: Status line text was successfully set.

FALSE: Unable to set status line text. This value is returned if the page ID specified in the ulPageId parameter is invalid or if the page was inserted without specifying the BKA_STATUSTEXTON attribute.

Remarks

If the text is longer that the status area length, only the text that fits in the status area is displayed.

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.