IERegGetDwEx

Reads an Internet Explorer registry setting that’s defined to have REG_DWORD type and may want placeholders in names for its key or value.

Declaration

HRESULT 
IERegGetDwEx (
    UINT uSetting,
    DWORD *pdwData,
    PCWSTR pszSubkeyPlaceholder,
    PCWSTR pszValuePlaceholder);

Parameters

The uSetting argument is an index that identifies the setting. For a list of supported settings, see the general notes on the Internet Explorer Registry API.

The pdwData argument provides the address of a variable that is to receive the setting’s REG_DWORD data.

The pszSubkeyPlaceholder is the address of a null-terminated string to use as a placeholder in naming the subkey for the setting, or may be NULL if no placeholder is intended.

The pszValuePlaceholder is the address of a null-terminated string to use as a placeholder in naming the registry value for the setting, or may be NULL if no placeholder is intended.

Return Value

The function returns zero for success, else an error code.

Behaviour

If pdwData is NULL, the function cannot do anything useful, and fails (returning E_FAIL).

It is an error (E_INVALIDARG) if either placeholder argument is given but contains a backslash.

If the given index is unsupported, the function fails (returning 0x80040704).

If the selected setting expects a placeholder but either none is given or use of the placeholder would give the subkey or value a name that exceeds MAX_PATH characters, then the function fails (returning 0x80040705).

The function looks for the indicated setting at its allowed locations in the registry. It ignores values that are present but whose data does not have the type that is defined for that setting. Register errors while looking for a value just mean the value is not present. The function succeeds if either

• a value is found and has REG_DWORD data
• or no value is found but the setting provides a REG_DWORD default.

Possible error codes from the registry search are:

• 0x80040700 if the value is not found and does not have a default;
• 0x80040701 if the value is found or defaulted, but its data is not of type REG_DWORD.

Availability

The IERegGetDwEx function is exported from IERTUTIL as ordinal 152 in version 8.0 and higher.