BKM INSERTPAGE

This message inserts the specified page into the notebook data list.

Syntax

param1
    ULONG  ulPageId;    /* Page ID for placement. */

param2
    USHORT usPageStyle; /* Style attributes. */
    USHORT usPageOrder; /* Order attributes. */

Parameters

ulPageId (ULONG) - input

Page identifier used for the placement of the inserted page. This identifier is ignored if the BKA_FIRST or BKA_LAST attribute of the usPageOrder parameter is specified.

usPageStyle (USHORT) - input

Attributes that specify the style to be used for an inserted page. You can specify one attribute from each of the following groups by using logical OR operators (|) to combine attributes:

Specify the following for automatic page position and size: BKA_AUTOPAGESIZE: Notebook handles the positioning and sizing of the application page window specified in the BKM_SETPAGEWINDOWHWND message.
Specify the following to display status area text: BKA_STATUSTEXTON: Page is to be displayed with status area text. If this attribute is not specified, the application cannot associate a text string with the status area of the page being inserted.
Specify one of the following if the page is to have a major or minor tab attribute: BKA_MAJOR: Inserted page will have a major tab attribute.; BKA_MINOR: Inserted page will have a minor tab attribute.

usPageOrder (USHORT) - input

Placement of page relative to the previously inserted pages. You can specify one of the following attributes:

BKA_FIRST: Insert page at the front of the notebook. The page ID specified in the ulPageId parameter for param1 is ignored if this is specified.

BKA_LAST: Insert page at the end of the notebook. The page ID specified in the ulPageId parameter for param1 is ignored if this is specified.

BKA_NEXT: Insert 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, NULL is returned and no page is inserted.

BKA_PREV: Insert 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, NULL is returned and no page is inserted.

Returns

ulPageId (ULONG) - returns: Identifier for the inserted page.; NULL: The page was not inserted into the notebook. An invalid page ID was specified for the ulPageId parameter for param1 or not enough space was available to allocate the page data.; Other: Identifier for the inserted page.

Remarks

The notebook control allocates and manages the storage needed for the new page. If neither the BKA_MAJOR or BKA_MINOR attribute is specified, the page is inserted with no tab attributes.

If the application does not specify the BKA_AUTOPAGESIZE attribute, it must handle the positioning and sizing of the application page window when it receives the BKN_NEWPAGESIZE notification code.

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.