BKM_QUERYPAGEID - Parameters

ulPageId (ULONG)

Location page ID.

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)

Page ID query order.

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)

Page style.

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.

ulPageId (ULONG)

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.

---

[Back: BKM_QUERYPAGEID Return Value - ulPageId]
[Next: BKM_QUERYPAGEID - Syntax]