IDocHostUIHandler::GetOptionKeyPath Method

---

Returns the registry key under which MSHTML stores user preferences.

Syntax

HRESULT GetOptionKeyPath( 
    LPOLESTR *pchKey,
    DWORD dwReserved
);

Parameters

pchKey

Address of an LPOLESTR that receives the registry subkey string where the host stores its default options.

dwReserved

Reserved for future use. Not currently used.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

The registry subkey will be under the HKEY_CURRENT_USER key. The implementation must allocate this memory using CoTaskMemAlloc. The calling application is responsible for freeing this memory using CoTaskMemFree. Even if the method fails, this parameter should be set to NULL.

If pchKey is NULL on return from this function, MSHTML uses the default location for storing options in the registry.

Windows CE

With Windows CE only, this method always returns S_FALSE.

Windows CE	Use version 2.12 and later
Minimum availability	Internet Explorer 4.0