BKM QUERYPAGEID

This message queries the page identifier for the specified page.

Syntax

param1
ULONG ulPageId;     /* Location page ID. */

param2
USHORT usQueryOrder; /* Page ID query order. */
USHORT usPageStyle;  /* Page style. */

Parameters

ulPageId (ULONG) - Input

Page identifier used for locating the requested page. This identifier is ignored if the BKA_FIRST, BKA_LAST, or BKA_TOP attribute is specified.

usQueryOrder (USHORT) - Input

Order in which to query the page identifier:

BKA_FIRST: Get the page identifier for the first page. The page ID specified in the ulPageId parameter for param1 is ignored if this is specified.

BKA_LAST: Get the page identifier for the last page. The page ID specified in the ulPageId parameter for param1 is ignored if this is specified.

BKA_NEXT: Get the page identifier for the page after the page whose ID is specified in the ulPageId parameter for param1. If the page ID specified in the ulPageId parameter is invalid, BOOKERR_INVALID_PARAMETERS is returned.

BKA_PREV: Get the page identifier for the page before the page whose ID is specified in the ulPageId parameter for param1. If the page ID specified in the ulPageId parameter is invalid, BOOKERR_INVALID_PARAMETERS is returned.

BKA_TOP: Get the page identifier for the page currently visible in the notebook. The page ID specified in the ulPageId parameter for param1 is ignored if this is specified.

usPageStyle (USHORT) - Input

Page style for which to query the page identifier. If neither of these attributes is specified, the usPageStyle parameter is ignored:

BKA_MAJOR: Query page with major tab attribute.

BKA_MINOR: Query page with minor tab attribute. If a major tab page is found before the minor tab page, the search is ended and 0 is returned.

Returns

ulPageId (ULONG) - returns

Retrieved page ID:

BOOKERR_INVALID_PARAMETERS: Returned if the page ID specified for the ulPageId parameter for param1 is invalid when specifying either the BKA_PREV or BKA_NEXT attribute in the usQueryOrder parameter.

0: Requested page not found. This could be an indication that the end or front of the list has been reached, or that the notebook is empty.

Other: Retrieved page identifier.

Remarks

If the BKA_FIRST, BKA_LAST, or BKA_TOP attribute is specified, the page ID in the ulPageId parameter is ignored.

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.