Función SHRegSetUSValueA (shlwapi.h)

Establece un valor de subclave del Registro en un subárbol específico del usuario (HKEY_CURRENT_USER o HKEY_LOCAL_MACHINE).

Sintaxis

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

Puntero a una cadena terminada en null con el nombre de la subclave.

[in] pszValue

Tipo: LPCTSTR

Puntero a una cadena terminada en null que especifica el nombre del valor.

[in] dwType

Tipo: DWORD

Tipo de datos que se van a almacenar. Este parámetro debe ser el tipo REG_SZ . Para obtener más información, consulte Tipos de datos del Registro.

[in, optional] pvData

Tipo: LPVOID*

Puntero a una cadena terminada en null que contiene el valor que se va a establecer para la clave especificada.

[in, optional] cbData

Tipo: DWORD

Longitud, en bytes, de la cadena a la que apunta el parámetro pvData , sin incluir el carácter nulo de terminación.

[in, optional] dwFlags

Tipo: DWORD

Marcas que indican dónde se deben escribir los datos.

SHREGSET_HKCU

Escriba en HKEY_CURRENT_USER si está vacío.

SHREGSET_FORCE_HKCU

Escriba en HKEY_CURRENT_USER.

SHREGSET_HKLM

Escriba en HKEY_LOCAL_MACHINE si está vacío.

SHREGSET_FORCE_HKLM

Escriba en HKEY_LOCAL_MACHINE.

SHREGSET_DEFAULT

Equivalente a (SHREGSET_FORCE_HKCU SHREGSET_HKLM | ).

Valor devuelto

Tipo: LSTATUS

Devuelve ERROR_SUCCESS si se ejecuta correctamente o si un código de error distinto de cero definido en Winerror.h de lo contrario. Puede usar la función FormatMessage con la marca FORMAT_MESSAGE_FROM_SYSTEM para recuperar una descripción genérica del error.

Comentarios

Esta función abre la clave cada vez que se usa. Si el código implica establecer una serie de valores en la misma clave, es más eficaz abrir la clave una vez con SHRegOpenUSKey y, a continuación, usar SHRegWriteUSValue para escribir los datos.

Nota

El encabezado shlwapi.h define SHRegSetUSValue como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	shlwapi.h
Library	Shlwapi.lib
Archivo DLL	Shlwapi.dll (versión 4.71 o posterior)