User Interface

---

Detailed Description

Functions and data structures for interacting with the user interface.

Modules
	Actions
	Alerter and Error Reporting
	Configuration Panels
	Hyperlink
	Credentials acquisition
	Property sheets
	Connecting to NetIDMgr from another process
	Duration sliders
Typedefs
typedef khm_int32(KHMAPI *)	khm_ui_callback (HWND hwnd_main_wnd, void *rock)
	UI callback function.
Functions
KHMEXP void KHMAPI	khm_get_lib_version (khm_version *libver, khm_ui_4 *apiver)
	Get the version of the NetIDMgr library.
KHMEXP khm_ui_4 KHMAPI	khm_get_commctl_version (khm_version *pdvi)
	Return the version of Common Control library.
KHMEXP khm_int32 KHMAPI	khui_request_UI_callback (khm_ui_callback cb, void *rock)
	Request a UI callback.

---

Typedef Documentation

typedef khm_int32(KHMAPI *) khm_ui_callback(HWND hwnd_main_wnd, void *rock)

UI callback function.

Used with khui_request_UI_callback().

See also:

khui_request_UI_callback()

---

Function Documentation

KHMEXP khm_ui_4 KHMAPI khm_get_commctl_version

(

khm_version *

pdvi

)

Return the version of Common Control library.

Can be used to check the version of the Windows Common Control library that is currently loaded. The return value of the function is the packed version value obatained by the macro :

    MAKELONG(vesion->dwMinorVersion, version->dwMajorVersion);

The pdvi parameter is optional. Specify NULL if this is not required.

KHMEXP void KHMAPI khm_get_lib_version	(	khm_version *	libver,
		khm_ui_4 *	apiver
	)

Get the version of the NetIDMgr library.

Parameters:

[out]	libver	Receives the version of the library.
[out]	apiver	Receives the API version of the library. Optional. Set to NULL if this value is not required.

Note:

When the NetIDMgr framework loads a plugin, it checks the version information of the plugin against the version of the library to determine if the plugin is compatible.

KHMEXP khm_int32 KHMAPI khui_request_UI_callback	(	khm_ui_callback	cb,
		void *	rock
	)

Request a UI callback.

In general, plug-ins in Network Identity Manager run in their own thread and will not be able to interact with the user directly by creating windows of its own. There are exceptions to this, such as when the plug-in is responding to a new credentials request or if the plug-in provides configuration panels. However, if a plug-in needs to provide a user interface to the user outside of the provisions already provided by Network Identity Manager, it needs to do so from within the user interface thread.

To do so, a plug-in would provide a callback function of the type khm_ui_callback to this function. The Network Identity Manager will then call the callback function from within the user interface thread. At this point, the callback function can create any windows it wishes to create and interact with the user directly.

The callback function would be called synchronously. khui_request_UI_callback() will not return until the user interface processes the request and calls the callback function. The return code of khui_request_UI_callback() will be the return code of the callback.

Parameters:

[in]	cb	The callback function which will be called from the user interface thread.
[in]	rock	An arbitrary parameter which will be passed into the callback function.

Returns:

The return value of cb.

Note:

When the plug-in creates any windows, it should specify the window handle provided via the hwnd_main_wnd parameter as the parent window.

See also:

khm_ui_callback

---