registry.c File Reference

#include "umandlg.h"

Include dependency graph for registry.c:

Go to the source code of this file.

Macros
#define	ACCESS_UTILMAN_KEY   L"SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Accessibility\\Utility Manager"
#define	UTILMAN_KEY   L"SOFTWARE\\Microsoft\\Utility Manager"
#define	OSK_KEY   L"On-Screen Keyboard"
#define	MAGNIFIER_KEY   L"Magnifier"

Functions
BOOL	InitAppRegKey (IN HKEY hPredefinedKey, IN LPCWSTR lpszSubKey, OUT PHKEY phKey, OUT LPDWORD lpdwDisposition)
BOOL	QueryAppSettings (IN HKEY hKey, IN LPCWSTR lpszSubKey, IN LPCWSTR lpszRegValue, OUT PVOID ReturnedData, IN OUT LPDWORD lpdwSizeData)
BOOL	SaveAppSettings (IN HKEY hKey, IN LPCWSTR lpszRegValue, IN DWORD dwRegType, IN PVOID Data, IN DWORD cbSize)

Variables
REGISTRY_DATA	RegData
REGISTRY_SETTINGS	Settings

Macro Definition Documentation

ACCESS_UTILMAN_KEY

#define ACCESS_UTILMAN_KEY   L"SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Accessibility\\Utility Manager"

Definition at line 19 of file registry.c.

MAGNIFIER_KEY

#define MAGNIFIER_KEY   L"Magnifier"

Definition at line 22 of file registry.c.

OSK_KEY

#define OSK_KEY   L"On-Screen Keyboard"

Definition at line 21 of file registry.c.

UTILMAN_KEY

#define UTILMAN_KEY   L"SOFTWARE\\Microsoft\\Utility Manager"

Definition at line 20 of file registry.c.

Function Documentation

InitAppRegKey()

BOOL InitAppRegKey	(	IN HKEY	hPredefinedKey,
		IN LPCWSTR	lpszSubKey,
		OUT PHKEY	phKey,
		OUT LPDWORD	lpdwDisposition
	)

@InitAppRegKey

Initialize a key. The function may not necessarily create it but open the key if it already exists. The disposition pointed lpdwDisposition determines that. This is a function helper.

Parameters

[in]	hPredefinedKey	The predefined key (e.g. HKEY_CLASSES_ROOT).
[in]	lpszSubKey	The path to the sub key to be created.
[out]	phKey	A pointer that receives a handle to the key given by the function.
[out]	lpdwDisposition	A pointer that receives the disposition given by the function.

Returns

Returns TRUE if the function successfully created a key (or opened it), FALSE otherwise for failure.

Definition at line 50 of file registry.c.

{
    LONG lResult;
 
    lResult = RegCreateKeyExW(hPredefinedKey,
                              lpszSubKey,
                              0,
                              NULL,
                              0,
                              KEY_WRITE,
                              NULL,
                              phKey,
                              lpdwDisposition);
    if (lResult != ERROR_SUCCESS)
    {
        DPRINT("InitAppRegKey(): Failed to create the following key (or open the key) of path \"%S\". The error code is \"%li\".\n", lpszSubKey, lResult);
        return FALSE;
    }
 
    return TRUE;
}

QueryAppSettings()

BOOL QueryAppSettings	(	IN HKEY	hKey,
		IN LPCWSTR	lpszSubKey,
		IN LPCWSTR	lpszRegValue,
		OUT PVOID	ReturnedData,
		IN OUT LPDWORD	lpdwSizeData
	)

@QueryAppSettings

Query the setting from the application's key. This is a function helper.

Parameters

[in]	hKey	A handle to a key.
[in]	lpszSubKey	The path to a sub-key.
[in]	lpszRegValue	The registry value where we need to get the data from.
[out]	ReturnedData	An arbitrary pointer that receives the returned data. Being arbitrary, the data can be of any type.
[in,out]	lpdwSizeData	A pointer to the returned data pointed by ReturnedData parameter that retrieves the size of the aforementioned data, in bytes.

Returns

Returns TRUE if the function successfully loaded the value we wanted, FALSE otherwise for failure.

Definition at line 102 of file registry.c.

{
    LONG lResult;
    HKEY hKeyQueryValue;
 
    lResult = RegOpenKeyExW(hKey,
                            lpszSubKey,
                            0,
                            KEY_READ,
                            &hKeyQueryValue);
    if (lResult != ERROR_SUCCESS)
    {
        DPRINT("QueryAppSettings(): Failed to open the key of path \"%S\". The error code is \"%li\".\n", lpszSubKey, lResult);
        return FALSE;
    }
 
    lResult = RegQueryValueExW(hKeyQueryValue,
                               lpszRegValue,
                               NULL,
                               NULL,
                               (LPBYTE)&ReturnedData,
                               lpdwSizeData);
    if (lResult != ERROR_SUCCESS)
    {
        DPRINT("QueryAppSettings(): Failed to query the data from value \"%S\". The error code is \"%li\".\n", lpszRegValue, lResult);
        RegCloseKey(hKeyQueryValue);
        return FALSE;
    }
 
    RegCloseKey(hKeyQueryValue);
    return TRUE;
}

SaveAppSettings()

BOOL SaveAppSettings	(	IN HKEY	hKey,
		IN LPCWSTR	lpszRegValue,
		IN DWORD	dwRegType,
		IN PVOID	Data,
		IN DWORD	cbSize
	)

@SaveAppSettings

Save an application's setting data to the Registry. This is a function helper.

Parameters

[in]	hKey	A handle to a key.
[in]	lpszRegValue	The path to the sub key where the value needs to be created.
[out]	dwRegType	The type of registry value to be created (e.g. a REG_DWORD).
[in]	Data	A pointer to an arbitrary data for the value to be set. Being arbitrary, the data can be of any type (in conformity with the registry type pointed by dwRegType) otherwise the function might lead to a undefined behaviour.
[in]	cbSize	The size of the buffer data pointed by Data parameter, in bytes.

Returns

Returns TRUE if the function successfully saved the application's setting, FALSE otherwise for failure.

Definition at line 166 of file registry.c.

{
    LONG lResult;
    HKEY hKeySetValue;
 
    lResult = RegOpenKeyExW(hKey,
                            NULL,
                            0,
                            KEY_SET_VALUE,
                            &hKeySetValue);
    if (lResult != ERROR_SUCCESS)
    {
        DPRINT("SaveAppSettings(): Failed to open the key, the error code is \"%li\"!\n", lResult);
        return FALSE;
    }
 
    lResult = RegSetValueExW(hKeySetValue,
                             lpszRegValue,
                             0,
                             dwRegType,
                             (LPBYTE)&Data,
                             cbSize);
    if (lResult != ERROR_SUCCESS)
    {
        DPRINT("SaveAppSettings(): Failed to set the \"%S\" value with data, the error code is \"%li\"!\n", lpszRegValue, lResult);
        RegCloseKey(hKeySetValue);
        return FALSE;
    }
 
    RegCloseKey(hKeySetValue);
    return TRUE;
}

Variable Documentation

RegData

REGISTRY_DATA RegData

Definition at line 14 of file registry.c.

Settings

REGISTRY_SETTINGS Settings

Definition at line 15 of file registry.c.