Função RegSetValueA (winreg.h)

Artigo
03/09/2024

Define os dados para o valor padrão ou sem nome de uma chave do Registro especificada. Os dados devem ser uma cadeia de texto.

Nota Essa função é fornecida apenas para compatibilidade com versões de 16 bits do Windows. Os aplicativos devem usar a função RegSetValueEx .

Sintaxe

LSTATUS RegSetValueA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey,
  [in]           DWORD  dwType,
  [in]           LPCSTR lpData,
  [in]           DWORD  cbData
);

Parâmetros

[in] hKey

Um identificador para uma chave aberta do Registro. A chave deve ter sido aberta com o direito de acesso KEY_SET_VALUE. Para obter mais informações, consulte Segurança de Chave do Registro e Direitos de Acesso.

Esse identificador é retornado pela função RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyEx ou RegOpenKeyTransacted . Também pode ser uma das seguintes chaves predefinidas:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in, optional] lpSubKey

O nome de uma subchave do parâmetro hKey . A função define o valor padrão da subchave especificada. Se lpSubKey não existir, a função a criará.

Os nomes de chave não diferenciam maiúsculas de minúsculas.

Se esse parâmetro for NULL ou apontar para uma cadeia de caracteres vazia, a função definirá o valor padrão da chave identificada por hKey.

Para obter mais informações, consulte Limites de tamanho do elemento do Registro.

[in] dwType

O tipo de informação a ser armazenada. Esse parâmetro deve ser o tipo REG_SZ. Para armazenar outros tipos de dados, use a função RegSetValueEx .

[in] lpData

Os dados a serem armazenados. Esse parâmetro não pode ser NULL.

[in] cbData

Este parâmetro é ignorado. A função calcula esse valor com base no tamanho dos dados no parâmetro lpData .

Retornar valor

Se a função obtiver êxito, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor de retorno será o código de erro diferente de zero definido em Winerror.h. Você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM para obter uma descrição genérica do erro.

Comentários

Se a chave especificada pelo parâmetro lpSubKey não existir, a função RegSetValue a criará.

Se a versão ANSI dessa função for usada (chamando explicitamente RegSetValueA ou não definindo UNICODE antes de incluir o arquivo Windows.h), o parâmetro lpData deverá ser uma cadeia de caracteres ANSI. A cadeia de caracteres é convertida em Unicode antes de ser armazenada no registro.

Observação

O cabeçalho winreg.h define RegSetValue 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 [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	winreg.h (inclua Windows.h)
Biblioteca	Advapi32.lib
DLL	Advapi32.dll