Windows Control Panel Library
[Libraries]

---

Detailed Description

Created: 26th May 2006 Updated: 13th March 2007.

This library contains classes and functions for manipulation of the Windows Control Panel.

The Windows Control Panel is XXX XXX XXX. The Windows Control Panel Library provides a suite of classes that represent these entities and provide facilities for accessing, enumerating and modifying them:

• The winstl::basic_reg_key class template represents a registry key. It provides methods for creating, opening, deleting keys, and accessing and modifying values.
• The winstl::basic_reg_value class template represents a registry value. It provides methods for retrieving the value's value (!) in a variety of types and forms.
• The winstl::basic_reg_key_sequence class template provides an STL collection for accessing the sub-keys of a given key. Its value type is (a specialisation of) winstl::basic_reg_key.
• The winstl::basic_reg_value_sequence class template provides an STL collection for accessing the values of a given key. Its value type is (a specialisation of) winstl::basic_reg_value.

Classes
class	applet
	Represents a Control Panel Applet. More...
class	applet_module
	Represents a Control Panel Applet module, and provides methods for loading and accessing applets. More...
class	control_panel_exception
	Exception thrown by the Windows Control Panel library. More...
class	applet_entry_not_found_exception
	Indicates that the control panel entry point cannot be found in the control panel library. More...
Functions
STLSOFT_INLINE BOOL	winstl__control_panel_init (control_panel_entry_t entry, HWND hwnd)
	[C, C++] Initialises a control panel applet module.
STLSOFT_INLINE void	winstl__control_panel_uninit (control_panel_entry_t entry, HWND hwnd)
	[C, C++] Uninitialises a control panel applet module.
STLSOFT_INLINE size_t	winstl__control_panel_get_count (control_panel_entry_t entry, HWND hwnd)
	[C, C++] Retrieves the number of control panel applets within a control panel applet module.
STLSOFT_INLINE void	winstl__control_panel_inquire (control_panel_entry_t entry, HWND hwnd, size_t index, LPCPLINFO info)
	[C, C++] Issues an inquiry control (CPL_INQUIRE) to a control panel applet.
STLSOFT_INLINE void	winstl__control_panel_newinquire (control_panel_entry_t entry, HWND hwnd, size_t index, LPNEWCPLINFO info)
	[C, C++] Issues a "new" inquiry control (CPL_NEWINQUIRE) to a control panel applet.
STLSOFT_INLINE BOOL	winstl__control_panel_run_data (control_panel_entry_t entry, HWND hwnd, size_t index, LONG data)
	[C, C++] Issues a run control (CPL_DBLCLK) to a control panel applet, including caller-supplied data.
STLSOFT_INLINE BOOL	winstl__control_panel_run_params_a (control_panel_entry_t entry, HWND hwnd, size_t index, char const *params)
	[C, C++] Issues a run control (CPL_STARTWPARMSA) to a control panel applet, including caller-supplied parameter string.
STLSOFT_INLINE BOOL	winstl__control_panel_run_params_w (control_panel_entry_t entry, HWND hwnd, size_t index, wchar_t const *params)
	[C, C++] Issues a run control (CPL_STARTWPARMSW) to a control panel applet, including caller-supplied parameter string.
STLSOFT_INLINE void	winstl__control_panel_stop (control_panel_entry_t entry, HWND hwnd, size_t index, LONG data)
	[C, C++] Issues a stop control (CPL_STOP) to a control panel applet.
BOOL	control_panel_init (control_panel_entry_t entry, HWND hwnd)
	Initialises a control panel applet module.
void	control_panel_uninit (control_panel_entry_t entry, HWND hwnd)
	Uninitialises a control panel applet module.
size_t	control_panel_get_count (control_panel_entry_t entry, HWND hwnd)
	Retrieves the number of control panel applets within a control panel applet module.
void	control_panel_inquire (control_panel_entry_t entry, HWND hwnd, size_t index, LPCPLINFO info)
	Issues an inquiry control (CPL_INQUIRE) to a control panel applet.
void	control_panel_newinquire (control_panel_entry_t entry, HWND hwnd, size_t index, LPNEWCPLINFO info)
	Issues a "new" inquiry control (CPL_NEWINQUIRE) to a control panel applet.
BOOL	control_panel_run_data (control_panel_entry_t entry, HWND hwnd, size_t index, LONG data)
	Issues a run control (CPL_DBLCLK) to a control panel applet, including caller-supplied data.
BOOL	control_panel_run_params_a (control_panel_entry_t entry, HWND hwnd, size_t index, char const *params)
	Issues a run control (CPL_STARTWPARMSA) to a control panel applet, including caller-supplied parameter string.
BOOL	control_panel_run_params_w (control_panel_entry_t entry, HWND hwnd, size_t index, wchar_t const *params)
	Issues a run control (CPL_STARTWPARMSW) to a control panel applet, including caller-supplied parameter string.
BOOL	control_panel_run (control_panel_entry_t entry, HWND hwnd, size_t index, LONG data)
	Issues a run control (CPL_DBLCLK) to a control panel applet, including caller-supplied data.
BOOL	control_panel_run (control_panel_entry_t entry, HWND hwnd, size_t index, char const *params)
	Issues a run control (CPL_STARTWPARMSA) to a control panel applet, including caller-supplied parameter string.
BOOL	control_panel_run (control_panel_entry_t entry, HWND hwnd, size_t index, wchar_t const *params)
	Issues a run control (CPL_STARTWPARMSW) to a control panel applet, including caller-supplied parameter string.
void	control_panel_stop (control_panel_entry_t entry, HWND hwnd, size_t index, LONG data)
	Issues a stop control (CPL_STOP) to a control panel applet.

---

Function Documentation

size_t winstl::control_panel_get_count	(	control_panel_entry_t	entry,
		HWND	hwnd
	)			[inline]

Retrieves the number of control panel applets within a control panel applet module.

References winstl__control_panel_get_count().

BOOL winstl::control_panel_init	(	control_panel_entry_t	entry,
		HWND	hwnd
	)			[inline]

Initialises a control panel applet module.

References winstl__control_panel_init().

void winstl::control_panel_inquire	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		LPCPLINFO	info
	)			[inline]

Issues an inquiry control (CPL_INQUIRE) to a control panel applet.

References winstl__control_panel_inquire().

void winstl::control_panel_newinquire	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		LPNEWCPLINFO	info
	)			[inline]

Issues a "new" inquiry control (CPL_NEWINQUIRE) to a control panel applet.

References winstl__control_panel_newinquire().

BOOL winstl::control_panel_run	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		wchar_t const *	params
	)			[inline]

Issues a run control (CPL_STARTWPARMSW) to a control panel applet, including caller-supplied parameter string.

References winstl::control_panel_run_params_w().

BOOL winstl::control_panel_run	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		char const *	params
	)			[inline]

Issues a run control (CPL_STARTWPARMSA) to a control panel applet, including caller-supplied parameter string.

References winstl::control_panel_run_params_a().

BOOL winstl::control_panel_run	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		LONG	data
	)			[inline]

Issues a run control (CPL_DBLCLK) to a control panel applet, including caller-supplied data.

References winstl::control_panel_run_data().

BOOL winstl::control_panel_run_data	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		LONG	data
	)			[inline]

Issues a run control (CPL_DBLCLK) to a control panel applet, including caller-supplied data.

References winstl__control_panel_run_data().

Referenced by winstl::control_panel_run().

BOOL winstl::control_panel_run_params_a	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		char const *	params
	)			[inline]

Issues a run control (CPL_STARTWPARMSA) to a control panel applet, including caller-supplied parameter string.

References winstl__control_panel_run_params_a().

Referenced by winstl::control_panel_run().

BOOL winstl::control_panel_run_params_w	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		wchar_t const *	params
	)			[inline]

Issues a run control (CPL_STARTWPARMSW) to a control panel applet, including caller-supplied parameter string.

References winstl__control_panel_run_params_w().

Referenced by winstl::control_panel_run().

void winstl::control_panel_stop	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		LONG	data
	)			[inline]

Issues a stop control (CPL_STOP) to a control panel applet.

References winstl__control_panel_stop().

void winstl::control_panel_uninit	(	control_panel_entry_t	entry,
		HWND	hwnd
	)			[inline]

Uninitialises a control panel applet module.

References winstl__control_panel_uninit().

STLSOFT_INLINE size_t winstl__control_panel_get_count	(	control_panel_entry_t	entry,
		HWND	hwnd
	)

[C, C++] Retrieves the number of control panel applets within a control panel applet module.

References stlsoft_static_cast, and WINSTL_ASSERT.

Referenced by winstl::control_panel_get_count(), winstl__control_panel_inquire(), and winstl__control_panel_newinquire().

STLSOFT_INLINE BOOL winstl__control_panel_init	(	control_panel_entry_t	entry,
		HWND	hwnd
	)

[C, C++] Initialises a control panel applet module.

References WINSTL_ASSERT.

Referenced by winstl::control_panel_init().

STLSOFT_INLINE void winstl__control_panel_inquire	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		LPCPLINFO	info
	)

[C, C++] Issues an inquiry control (CPL_INQUIRE) to a control panel applet.

References stlsoft_reinterpret_cast, stlsoft_static_cast, winstl__control_panel_get_count(), and WINSTL_ASSERT.

Referenced by winstl::control_panel_inquire().

STLSOFT_INLINE void winstl__control_panel_newinquire	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		LPNEWCPLINFO	info
	)

[C, C++] Issues a "new" inquiry control (CPL_NEWINQUIRE) to a control panel applet.

References STLSOFT_NS_GLOBAL, STLSOFT_NUM_ELEMENTS, stlsoft_reinterpret_cast, stlsoft_static_cast, winstl__control_panel_get_count(), and WINSTL_ASSERT.

Referenced by winstl::control_panel_newinquire().

STLSOFT_INLINE BOOL winstl__control_panel_run_data	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		LONG	data
	)

[C, C++] Issues a run control (CPL_DBLCLK) to a control panel applet, including caller-supplied data.

References stlsoft_static_cast, and WINSTL_ASSERT.

Referenced by winstl::control_panel_run_data().

STLSOFT_INLINE BOOL winstl__control_panel_run_params_a	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		char const *	params
	)

[C, C++] Issues a run control (CPL_STARTWPARMSA) to a control panel applet, including caller-supplied parameter string.

References stlsoft_static_cast, and WINSTL_ASSERT.

Referenced by winstl::control_panel_run_params_a().

STLSOFT_INLINE BOOL winstl__control_panel_run_params_w	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		wchar_t const *	params
	)

[C, C++] Issues a run control (CPL_STARTWPARMSW) to a control panel applet, including caller-supplied parameter string.

References stlsoft_static_cast, and WINSTL_ASSERT.

Referenced by winstl::control_panel_run_params_w().

STLSOFT_INLINE void winstl__control_panel_stop	(	control_panel_entry_t	entry,
		HWND	hwnd,
		size_t	index,
		LONG	data
	)

[C, C++] Issues a stop control (CPL_STOP) to a control panel applet.

References stlsoft_static_cast, and WINSTL_ASSERT.

Referenced by winstl::control_panel_stop().

STLSOFT_INLINE void winstl__control_panel_uninit	(	control_panel_entry_t	entry,
		HWND	hwnd
	)

[C, C++] Uninitialises a control panel applet module.

References stlsoft_static_cast, and WINSTL_ASSERT.

Referenced by winstl::control_panel_uninit().