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 de 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, sem incluir o caractere nulo de terminação.

[in, optional] dwFlags

Tipo: DWORD

Sinalizadores que indicam onde os dados devem ser gravados.

SHREGSET_HKCU

Escreva para HKEY_CURRENT_USER se estiver vazio.

SHREGSET_FORCE_HKCU

Gravar em HKEY_CURRENT_USER.

SHREGSET_HKLM

Escreva para HKEY_LOCAL_MACHINE se estiver vazio.

SHREGSET_FORCE_HKLM

Gravar em HKEY_LOCAL_MACHINE.

SHREGSET_DEFAULT

Equivalente a (SHREGSET_FORCE_HKCU | SHREGSET_HKLM).

Valor de retorno

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.

Observações

Essa função abre a chave sempre que ela é usada. Se o código envolver a definiçã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.

Requisitos