Função SHSetValueA (shlwapi.h)

Artigo
11/20/2024

Define o valor de uma chave do Registro.

Sintaxe

LSTATUS SHSetValueA(
  [in]           HKEY    hkey,
  [in, optional] LPCSTR  pszSubKey,
  [in, optional] LPCSTR  pszValue,
  [in]           DWORD   dwType,
  [in, optional] LPCVOID pvData,
  [in]           DWORD   cbData
);

Parâmetros

[in] hkey

Tipo: HKEY

Um identificador para a chave aberta no momento ou qualquer um dos valores predefinidos a seguir.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Tipo: LPCTSTR

O endereço de uma cadeia de caracteres terminada em nulo que especifica o nome da subchave com a qual um valor está associado. Isso pode ser NULL ou um ponteiro para uma cadeia de caracteres vazia. Nesse caso, o valor é adicionado à chave identificada pelo parâmetro hkey.

[in, optional] pszValue

Tipo: LPCTSTR

O endereço de uma cadeia de caracteres terminada em nulo que especifica o valor. Esse valor pode ser NULL.

[in] dwType

Tipo: DWORD

Tipo de dados a serem armazenados. Esse parâmetro deve ser o tipo de REG_SZ. Para obter mais informações, consulte tipos de dados do Registro.

[in, optional] pvData

Tipo: LPCVOID

Ponteiro para um buffer que contém os dados a serem definidos para o valor especificado. Esse valor pode ser NULL.

[in] cbData

Tipo: DWORD

Comprimento, em bytes, do buffer apontado pelo parâmetro pvData. Se os dados forem uma cadeia de caracteres terminada em nulo, esse comprimento incluirá o caractere nulo de encerramento.

Valor de retorno

Tipo: LSTATUS

Retorna ERROR_SUCCESS se bem-sucedido; caso contrário, um 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 recuperar uma descrição genérica do erro.

Observações

Nota

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

Requisitos

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

Compartilhar via