Função SHRegSetUSValueA (shlwapi.h)
Define um valor de subchave do Registro em uma subárvore específica do usuário (HKEY_CURRENT_USER ou HKEY_LOCAL_MACHINE).
Sintaxe
LSTATUS SHRegSetUSValueA(
[in] LPCSTR pszSubKey,
[in] LPCSTR pszValue,
[in] DWORD dwType,
[in, optional] const void *pvData,
[in, optional] DWORD cbData,
[in, optional] DWORD dwFlags
);
Parâmetros
[in] pszSubKey
Tipo: LPCTSTR
Um ponteiro para uma cadeia de caracteres terminada em nulo com o nome da subchave.
[in] pszValue
Tipo: LPCTSTR
Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome do valor.
[in] dwType
Tipo: DWORD
Tipo de dados a serem armazenados. Esse parâmetro deve ser o tipo REG_SZ . Para obter mais informações, consulte Tipos de dados do Registro.
[in, optional] pvData
Tipo: LPVOID*
Apointer para uma cadeia de caracteres terminada em nulo que contém o valor a ser definido para a chave especificada.
[in, optional] cbData
Tipo: DWORD
Comprimento, em bytes, da cadeia de caracteres apontada pelo parâmetro pvData , não incluindo o caractere nulo de terminação.
[in, optional] dwFlags
Tipo: DWORD
Sinalizadores que indicam onde os dados devem ser gravados.
SHREGSET_HKCU
Escreva em HKEY_CURRENT_USER se estiver vazio.
SHREGSET_FORCE_HKCU
Gravar em HKEY_CURRENT_USER.
SHREGSET_HKLM
Escreva em HKEY_LOCAL_MACHINE se estiver vazio.
SHREGSET_FORCE_HKLM
Gravar em HKEY_LOCAL_MACHINE.
SHREGSET_DEFAULT
Equivalente a (SHREGSET_FORCE_HKCU | SHREGSET_HKLM).
Retornar valor
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
Essa função abre a chave sempre que é usada. Se o código envolver a configuração de uma série de valores na mesma chave, será mais eficiente abrir a chave uma vez com SHRegOpenUSKey e, em seguida, usar SHRegWriteUSValue para gravar os dados.
Observação
O cabeçalho shlwapi.h define SHRegSetUSValue 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) |