Função SHRegCreateUSKeyA (shlwapi.h)

Cria ou abre uma subchave do Registro em uma subárvore específica do usuário (HKEY_CURRENT_USER ou HKEY_LOCAL_MACHINE).

Sintaxe

LSTATUS SHRegCreateUSKeyA(
  [in]           LPCSTR  pszPath,
  [in]           REGSAM  samDesired,
  [in, optional] HUSKEY  hRelativeUSKey,
  [out]          PHUSKEY phNewUSKey,
  [in]           DWORD   dwFlags
);

Parâmetros

[in] pszPath

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém a subchave a ser criada ou aberta. Se um valor com esse nome já estiver presente na subchave, ele será aberto.

[in] samDesired

Tipo: REGSAM

O acesso de segurança desejado. Para obter mais informações sobre acesso à segurança, consulte REGSAM.

[in, optional] hRelativeUSKey

Tipo: HUSKEY

A chave a ser usada como base para caminhos relativos. Se pszPath for um caminho relativo, a chave especificada será relativa a hRelativeUSKey. Se pszPath for um caminho absoluto, defina hRelativeUSKey como NULL. Em seguida, a chave será criada em HKEY_LOCAL_MACHINE ou HKEY_CURRENT_USER, dependendo do valor de dwFlags.

[out] phNewUSKey

Tipo: PHUSKEY

Um ponteiro para um HUSKEY que receberá o identificador para a nova chave.

[in] dwFlags

Tipo: DWORD

A chave base sob a qual a chave deve ser aberta. Esse pode ser um ou mais dos valores a seguir.

SHREGSET_HKCU

Crie/abra a chave em HKEY_CURRENT_USER. Só criará uma chave se ela estiver vazia.

SHREGSET_FORCE_HKCU

Crie/abra a chave em HKEY_CURRENT_USER. Cria uma chave mesmo que não esteja vazia.

SHREGSET_HKLM

Crie/abra a chave em HKEY_LOCAL_MACHINE. Só criará uma chave se ela estiver vazia.

SHREGSET_FORCE_HKLM

Crie/abra a chave em HKEY_LOCAL_MACHINE. Cria uma chave mesmo que não esteja vazia.

SHREGSET_DEFAULT

Crie/abra a chave em HKEY_CURRENT_USER (forçado) e HKEY_LOCAL_MACHINE (somente se estiver vazio). Esse sinalizador é equivalente a (SHREGSET_FORCE_HKCU | SHREGSET_HKLM).

Valor retornado

Tipo: LSTATUS

Retorna ERROR_SUCCESS se tiver êxito ou um código de erro diferente de zero definido em Winerror.h caso contrário. Você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM para recuperar uma descrição genérica do erro.

Comentários

Se você quiser gravar valores na nova chave, use SHRegWriteUSValue para gravar cada valor, passando o identificador HUSKEY retornado por meio de phNewUSKey. Quando terminar, feche a chave do Registro específica do usuário com SHRegCloseUSKey.

Observação

O cabeçalho shlwapi.h define SHRegCreateUSKey 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

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)