SHRegGetBoolUSValue function

Retrieves a Boolean value from a registry subkey in a user-specific subtree (HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE).

Syntax

BOOL SHRegGetBoolUSValue(
  _In_     LPCTSTR pszSubKey,
  _In_opt_ LPCTSTR pszValue,
  _In_     BOOL    fIgnoreHKCU,
  _In_     BOOL    fDefault
);

Parameters

pszSubKey [in]

Type: LPCTSTR

A pointer to a null-terminated string with the name of the subkey relative to HKEY_LOCAL_MACHINE and HKEY_CURRENT_USER. For example, "Software\MyCompany\MyProduct".

pszValue [in, optional]

Type: LPCTSTR

A pointer to a null-terminated string that specifies the name of the value. This value can be NULL.

fIgnoreHKCU [in]

Type: BOOL

A variable that specifies which key to look under. When set to TRUE, SHRegGetUSValue ignores HKEY_CURRENT_USER and returns a value from HKEY_LOCAL_MACHINE.

fDefault [in]

Type: BOOL

A value that is returned if there is no registry value.

Return value

Type: BOOL

Returns either the value from the registry, or fDefault if none is found.

Requirements