CCPrintRegistry Namespace Reference

Functions to handle reading/writing to the printer registry settings. More...

Functions
DWORD	GetRegistryDWORD (HANDLE hPrinter, LPCTSTR lpSetting, DWORD dwDefault)
	Reads DWORD data from the printer's registry settings.
int	GetRegistryInt (HANDLE hPrinter, LPCTSTR lpSetting, int nDefault)
	Reads interger data from the printer's registry settings.
std::tstring	GetRegistryString (HANDLE hPrinter, LPCTSTR lpSetting, LPCTSTR lpDefault)
	Reads string data from the printer's registry settings.
bool	GetRegistryBool (HANDLE hPrinter, LPCTSTR lpSetting, bool bDefault)
	Reads boolean data from the printer's registry settings.
bool	SetRegistryDWORD (HANDLE hPrinter, LPCTSTR lpSetting, DWORD dwValue)
	Writes DWORD data to the printer's registry settings.
bool	SetRegistryInt (HANDLE hPrinter, LPCTSTR lpSetting, int nValue)
	Writes integer data to the printer's registry settings.
bool	SetRegistryBool (HANDLE hPrinter, LPCTSTR lpSetting, bool bValue)
	Writes boolean data to the printer's registry settings.
bool	SetRegistryString (HANDLE hPrinter, LPCTSTR lpSetting, const std::tstring &sValue)
	Writes string data to the printer's registry settings.
bool	EraseRegistryValue (HANDLE hPrinter, LPCTSTR lpSetting)
	Deletes a data value from the printer's registry settings.
bool	EnumRegistryValues (HANDLE hPrinter, STRLIST &lValues, LPCTSTR lpPrefix=NULL)
	Get list of value names of a key (optionally, only those that have a specific prefix).

---

Detailed Description

Functions to handle reading/writing to the printer registry settings.

---

Function Documentation

bool CCPrintRegistry::EnumRegistryValues	(	HANDLE	hPrinter,
		STRLIST &	lValues,
		LPCTSTR	lpPrefix = NULL
	)

Get list of value names of a key (optionally, only those that have a specific prefix).

Parameters:

	hPrinter	Handle to the printer
	lValues[out]	List to fill with the value names
	lpPrefix	Value name prefix; if not NULL, will only return the value names that start with the prefix

Returns:

true if all went well, false if something failed

Definition at line 119 of file CCPrintRegistry.cpp.

Referenced by CCPrintData::CleanOldData().

bool CCPrintRegistry::EraseRegistryValue	(	HANDLE	hPrinter,
		LPCTSTR	lpSetting
	)

Deletes a data value from the printer's registry settings.

Parameters:

	hPrinter	Handle to the printer
	lpSetting	Name of the key to remove

Returns:

true if removed successfully, false if failed

Definition at line 108 of file CCPrintRegistry.cpp.

Referenced by CCPrintData::CleanData(), and CCPrintData::SaveProcessData().

bool CCPrintRegistry::GetRegistryBool	(	HANDLE	hPrinter,
		LPCTSTR	lpSetting,
		bool	bDefault
	)			[inline]

Reads boolean data from the printer's registry settings.

Parameters:

	hPrinter	Handle to the printer
	lpSetting	Name of the key to read from
	bDefault	Default value of the flag if not found in the registry

Returns:

The value of the data in the registry, or the default value if not found there

Definition at line 61 of file CCPrintRegistry.h.

References GetRegistryDWORD().

Referenced by CCPrintLicenseInfo::ReadFromRegistry(), and ReadOEMDevFromRegistry().

DWORD CCPrintRegistry::GetRegistryDWORD	(	HANDLE	hPrinter,
		LPCTSTR	lpSetting,
		DWORD	dwDefault
	)

Reads DWORD data from the printer's registry settings.

Parameters:

	hPrinter	Handle to the printer
	lpSetting	Name of the key to get data from
	dwDefault	Default value of data (used if the key isn't found)

Returns:

The value in the registry, or the default if not found (or is of the wrong type)

Definition at line 39 of file CCPrintRegistry.cpp.

Referenced by CCPrintData::CleanOldData(), GetRegistryBool(), GetRegistryInt(), and CCPrintData::LoadProcessData().

int CCPrintRegistry::GetRegistryInt	(	HANDLE	hPrinter,
		LPCTSTR	lpSetting,
		int	nDefault
	)			[inline]

Reads interger data from the printer's registry settings.

Parameters:

	hPrinter	Handle to the printer
	lpSetting	Name of the key to read from
	nDefault	Default value of the integer if not found in the registry

Returns:

The value of the data in the registry, or the default value if not found there

Definition at line 51 of file CCPrintRegistry.h.

References GetRegistryDWORD().

Referenced by CCPrintLicenseInfo::ReadFromRegistry().

std::tstring CCPrintRegistry::GetRegistryString	(	HANDLE	hPrinter,
		LPCTSTR	lpSetting,
		LPCTSTR	lpDefault
	)

Reads string data from the printer's registry settings.

Parameters:

	hPrinter	Handle to the printer
	lpSetting	Name of the key to get data from
	lpDefault	Default value of data (used if the key isn't found)

Returns:

The value in the registry, or the default if not found (or is of the wrong type)

Definition at line 71 of file CCPrintRegistry.cpp.

References tstring.

Referenced by CCPrintData::CleanData(), DoLicensePage(), CCPrintData::LoadProcessData(), CCPrintLicenseInfo::ReadFromRegistry(), CCPrintData::ReloadProcessData(), and CCPrintData::UpdateProcessData().

bool CCPrintRegistry::SetRegistryBool	(	HANDLE	hPrinter,
		LPCTSTR	lpSetting,
		bool	bValue
	)			[inline]

Writes boolean data to the printer's registry settings.

Parameters:

	hPrinter	Handle to the printer
	lpSetting	Name of the key to write to
	bValue	Value to set

Definition at line 78 of file CCPrintRegistry.h.

References SetRegistryDWORD().

Referenced by CCPDFPrinterInstaller::DoInstall(), WriteOEMDevToRegistry(), and CCPrintLicenseInfo::WriteToRegistry().

bool CCPrintRegistry::SetRegistryDWORD	(	HANDLE	hPrinter,
		LPCTSTR	lpSetting,
		DWORD	dwValue
	)

Writes DWORD data to the printer's registry settings.

Parameters:

	hPrinter	Handle to the printer
	lpSetting	Name of the key to write data to
	dwValue	The value to write

Returns:

true if written successfully, false if failed

Definition at line 58 of file CCPrintRegistry.cpp.

Referenced by CCPrintData::SaveProcessData(), SetRegistryBool(), and SetRegistryInt().

bool CCPrintRegistry::SetRegistryInt	(	HANDLE	hPrinter,
		LPCTSTR	lpSetting,
		int	nValue
	)			[inline]

Writes integer data to the printer's registry settings.

Parameters:

	hPrinter	Handle to the printer
	lpSetting	Name of the key to write to
	nValue	Value to set

Definition at line 71 of file CCPrintRegistry.h.

References SetRegistryDWORD().

Referenced by CCPrintLicenseInfo::WriteToRegistry().

bool CCPrintRegistry::SetRegistryString	(	HANDLE	hPrinter,
		LPCTSTR	lpSetting,
		const std::tstring &	sValue
	)

Writes string data to the printer's registry settings.

Parameters:

	hPrinter	Handle to the printer
	lpSetting	Name of the key to write data to
	sValue	The value to write

Returns:

true if written successfully, false if failed

Definition at line 97 of file CCPrintRegistry.cpp.

Referenced by CCPDFPrinterInstaller::DoInstall(), CCPrintData::SaveProcessData(), and CCPrintLicenseInfo::WriteToRegistry().