Property sheets
[User Interface]

Data Structures
struct	tag_khui_property_sheet
	A property sheet. More...
struct	tag_khui_property_page
	A property sheet page. More...
Defines
#define	KHUI_PS_STATUS_NONE   0
	The property sheet hasn't been created yet.
#define	KHUI_PS_STATUS_RUNNING   1
	The property sheet is visible and running.
#define	KHUI_PS_STATUS_DONE   2
	The property sheet has completed running.
#define	KHUI_PS_STATUS_DESTROY   3
	The property sheet is in the process of being destroyed.
#define	KHUI_PS_MAX_PSP   16
	Maximum number of property sheet pages in a property sheet.
#define	KHUI_PPCT_IDENTITY   (-8)
	Special pseudo credtype for identity page.
#define	KHUI_PPCT_CREDENTIAL   (-9)
	Special pseudo credtype for credential page.
Typedefs
typedef tag_khui_property_sheet	khui_property_sheet
	A property sheet.
typedef tag_khui_property_page	khui_property_page
	A property sheet page.
Functions
KHMEXP khm_int32 KHMAPI	khui_ps_create_sheet (khui_property_sheet **sheet)
	Create a property sheet.
KHMEXP khm_int32 KHMAPI	khui_ps_add_page (khui_property_sheet *sheet, khm_int32 credtype, khm_int32 ordinal, LPPROPSHEETPAGE ppage, khui_property_page **page)
	Add a page to a property sheet.
KHMEXP khm_int32 KHMAPI	khui_ps_find_page (khui_property_sheet *sheet, khm_int32 credtype, khui_property_page **page)
	Retrieve a property page structure from a property sheet.
KHMEXP HWND KHMAPI	khui_ps_show_sheet (HWND parent, khui_property_sheet *sheet)
	Display the property sheet.
KHMEXP LRESULT KHMAPI	khui_ps_check_message (khui_property_sheet *sheet, PMSG msg)
	Check if the given message belongs to the property sheet.
KHMEXP khm_int32 KHMAPI	khui_ps_destroy_sheet (khui_property_sheet *sheet)
	Destroy a property sheet and all associated data structures.
KHMEXP khm_int32 KHMAPI	khui_property_wnd_set_record (HWND hwnd_pwnd, khm_handle record)

---

Define Documentation

#define KHUI_PS_STATUS_DONE   2

The property sheet has completed running.

At this point, it is safe to call khui_ps_destroy_sheet() to destroy the property sheet.

---

Function Documentation

KHMEXP khm_int32 KHMAPI khui_ps_add_page	(	khui_property_sheet *	sheet,
		khm_int32	credtype,
		khm_int32	ordinal,
		LPPROPSHEETPAGE	ppage,
		khui_property_page **	page
	)

Add a page to a property sheet.

Called by a plugin or the NetIDMgr application to add a page to a property sheet.

Pages can only be added before the property sheet is made visible to the user.

Parameters:

[in]	sheet	The property sheet to add the page to
[in]	credtype	The credentials type ID of the owner of the property page. This should be set to KCDB_CREDTYPE_INVALID if the type is not relevant.
[in]	ordinal	Requested ordinal. A positive integer which is used to order the pages in a property sheet. The pages are ordered based on ordinal first and then alphabetically by credentials type name. If the type is unavailable, then the ordering is undefined. Ordinals for credential type property pages can be in the range from 0 to 127. Ordinals 128 and above are reserved. Passing in 0 will work for credentials providers unless they provide more than one property page per credential, in which case the ordinal should be used to enforce an order.
[in]	ppage	Pointer to structure that will be passed to CreatePropertySheetPage() to create the property page. The structure is not managed by NetIDMgr at all, and must exist until the status of the property sheet changes to KHUI_PS_STATUS_RUNNING. The same pointer will be found in the p_page member of the khui_property_page structure.
[out]	page	A pointer will be returned here that will point to the newly created khui_property_page structure. Specify NULL if this value is not required. You can use khui_ps_find_page() to retrieve a pointer to the structure later.

KHMEXP LRESULT KHMAPI khui_ps_check_message	(	khui_property_sheet *	sheet,
		PMSG	msg
	)

Check if the given message belongs to the property sheet.

Note:

Only called by the NetIDMgr application

KHMEXP khm_int32 KHMAPI khui_ps_create_sheet

(

khui_property_sheet **

sheet

)

Create a property sheet.

Note:

Only called by the NetIDMgr application.

KHMEXP khm_int32 KHMAPI khui_ps_destroy_sheet

(

khui_property_sheet *

sheet

)

Destroy a property sheet and all associated data structures.

Note:

Only called by the NetIDMgr application.

KHMEXP HWND KHMAPI khui_ps_show_sheet	(	HWND	parent,
		khui_property_sheet *	sheet
	)

Display the property sheet.

Note:

Only called by the NetIDMgr application

---