SHOpenRegStream2A function

Opens a registry value and supplies a stream that can be used to read from or write to the value. This function supersedes SHOpenRegStream.

Syntax

IStream * SHOpenRegStream2A(
  HKEY   hkey,
  LPCSTR pszSubkey,
  LPCSTR pszValue,
  DWORD  grfMode
);

Parameters

hkey

Type: HKEY

Required. The subtree, such as HKEY_LOCAL_MACHINE, that contains the value.

pszSubkey

Type: LPCTSTR

Optional. Pointer to a null-terminated string that specifies the subkey that contains the value. This value can be NULL.

pszValue

Type: LPCTSTR

Pointer to a null-terminated string that specifies the value to be accessed. This value can be NULL.

grfMode

Type: DWORD

The type of access for the stream. This can be one of the following values:

STGM_READ

Open the stream for reading.

STGM_WRITE

Open the stream for writing.

STGM_READWRITE

Open the stream for reading and writing.

Return Value

Type: IStream*

Returns an IStream interface pointer if successful; otherwise, NULL. A NULL value can be caused by several situations, including an invalid hkey or pszSubkey, a subkey named by pszSubkey that does not exist, a caller without sufficient permissions to access the subkey, or an inability to open the stream.

Remarks

The calling application is responsible for calling the Release method of the returned object when that IStream object is no longer needed.

Requirements

   
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shlwapi.h
Library Shlwapi.lib
DLL Shlwapi.dll (version 5.0 or later)