SHOpenRegStreamA function (shlwapi.h)

Article
02/09/2023

Deprecated. Opens a registry value and supplies a stream that can be used to read from or write to the value.

Note This function has been replaced by SHOpenRegStream2. It is recommended that you use SHOpenRegStream2 at all times.

Syntax

IStream * SHOpenRegStreamA(
  [in]           HKEY   hkey,
  [in, optional] LPCSTR pszSubkey,
  [in, optional] LPCSTR pszValue,
  [in]           DWORD  grfMode
);

Parameters

[in] hkey

Type: HKEY

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

[in, optional] pszSubkey

Type: LPCTSTR

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

[in, optional] pszValue

Type: LPCTSTR

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

[in] 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 both 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, or an inability to open the stream.

Note In some situations, such as when the subkey named by pszSubkey does not exist or the caller does not have sufficient permissions to access the subkey, a zero-length stream is returned rather than a NULL value. SHOpenRegStream2 returns NULL in all error situations and is the preferred function for that reason.

Remarks

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

Note

The shlwapi.h header defines SHOpenRegStream as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
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 4.71 or later)

Share via