Função SHOpenRegStreamA (shlwapi.h)

  • Artigo

Preterido. Abre um valor do Registro e fornece um fluxo que pode ser usado para ler ou gravar no valor.

Nota Essa função foi substituída por SHOpenRegStream2. É recomendável que você use SHOpenRegStream2 o tempo todo.
 

Sintaxe

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

Parâmetros

[in] hkey

Tipo: HKEY

Obrigatórios. A subárvore, como HKEY_LOCAL_MACHINE, que contém o valor .

[in, optional] pszSubkey

Tipo: LPCTSTR

Opcional. Ponteiro para uma cadeia de caracteres terminada em nulo que especifica a subchave que contém o valor. Esse valor pode ser NULL.

[in, optional] pszValue

Tipo: LPCTSTR

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o valor a ser acessado. Esse valor pode ser NULL.

[in] grfMode

Tipo: DWORD

O tipo de acesso para o fluxo. Esse valor pode ser um dos seguintes:

STGM_READ

Abra o fluxo para leitura.

STGM_WRITE

Abra o fluxo para gravação.

STGM_READWRITE

Abra o fluxo para leitura e gravação.

Retornar valor

Tipo: IStream*

Retorna um ponteiro de interface IStream se for bem-sucedido; caso contrário, NULL. Um valor NULL pode ser causado por várias situações, incluindo um hkey ou pszSubkey inválido ou uma incapacidade de abrir o fluxo.

Nota Em algumas situações, como quando a subchave chamada por pszSubkey não existe ou o chamador não tem permissões suficientes para acessar a subchave, um fluxo de comprimento zero é retornado em vez de um valor NULL . SHOpenRegStream2 retorna NULL em todas as situações de erro e é a função preferencial por esse motivo.
 

Comentários

O aplicativo de chamada é responsável por chamar o método Release do objeto retornado quando esse objeto IStream não é mais necessário.

Observação

O cabeçalho shlwapi.h define SHOpenRegStream como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shlwapi.h
Biblioteca Shlwapi.lib
DLL Shlwapi.dll (versão 4.71 ou posterior)