BKM DELETEPAGE

This message deletes the specified page or pages from the notebook data list.

Syntax

param1
ULONG ulPageId;     /* Page identifier. */

param2
USHORT usDeleteFlag; /* Page range attribute. */

Parameters

ulPageId (ULONG) - Input

Page identifier for deletion. This is ignored if the BKA_ALL attribute of the usDeleteFlag parameter is specified.

usDeleteFlag (USHORT) - Input

Attribute that specifies the range of pages to be deleted:

BKA_SINGLE: Delete a single page.

BKA_TAB: If the page ID specified is that of a page with a major tab attribute, delete that page and all subsequent pages up to the next page that has a major tab attribute.

If the page ID specified is that of a page with a minor tab attribute, delete that page and all subsequent pages up to the next page that has either a major or minor tab attribute.

This attribute should only be specified for pages that have major or minor tab attributes. If a page with neither of these attributes is specified, FALSE is returned and no pages are deleted.

BKA_ALL: Delete all pages in the notebook.

Returns

rc (BOOL) - returns

Success indicator:

TRUE: Pages were successfully deleted.

FALSE: Unable to delete the page or pages. This is returned if an invalid page ID is specified for the ulPageId parameter or if the BKA_TAB attribute is specified for a page that has neither a major nor a minor tab attribute.

Remarks

The notebook frees all storage that it has allocated for the deleted page or pages. The application is responsible for deleting the application page window and bit map, if created.

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.