Función RegSetKeyValueA (winreg.h)

  • Artículo

Establece los datos del valor especificado en la clave del Registro y la subclave especificados.

Sintaxis

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

Parámetros

[in] hKey

Identificador de una clave del Registro abierta. La clave debe haberse abierto con el derecho de acceso KEY_SET_VALUE. Para obtener más información, consulte Derechos de acceso y seguridad de clave del Registro.

Este identificador lo devuelve la función RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyEx o RegOpenKeyTransacted . También puede ser una de las siguientes claves predefinidas:


   HKEY_CLASSES_ROOT
   HKEY_CURRENT_CONFIG
   HKEY_CURRENT_USER
   HKEY_LOCAL_MACHINE
   HKEY_USERS

[in, optional] lpSubKey

Nombre de la subclave relativa a la clave identificada por hKey. Si la subclave no existe, se crea como una clave no volátil con un descriptor de seguridad predeterminado. Si este parámetro es NULL, el valor se crea en la clave especificada por hKey.

[in, optional] lpValueName

Nombre del valor del Registro cuyos datos se van a actualizar.

[in] dwType

Tipo de datos al que apunta el parámetro lpData . Para obtener una lista de los posibles tipos, consulte Tipos de valor del Registro.

[in, optional] lpData

Datos que se almacenarán con el nombre de valor especificado.

En el caso de los tipos basados en cadenas, como REG_SZ, la cadena debe terminar en null. Con el REG_MULTI_SZ tipo de datos, la cadena debe terminarse con dos caracteres NULL.

[in] cbData

Tamaño de la información a la que apunta el parámetro lpData , en bytes. Si los datos son de tipo REG_SZ, REG_EXPAND_SZ o REG_MULTI_SZ, cbData debe incluir el tamaño del carácter o caracteres nulos de terminación.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.

Si la función no se ejecuta correctamente, el valor devuelto es un código de error distinto de cero definido en Winerror.h. Puede usar la función FormatMessage con la marca FORMAT_MESSAGE_FROM_SYSTEM para obtener una descripción genérica del error.

Comentarios

Para compilar una aplicación que usa esta función, defina _WIN32_WINNT como 0x0600 o posterior. Para obtener más información, vea Usar los encabezados de Windows.

Nota

El encabezado winreg.h define RegSetKeyValue 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o 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 Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado winreg.h (incluye Windows.h)
Library Advapi32.lib
Archivo DLL Advapi32.dll

Consulte también

RegDeleteKeyValue

Funciones del Registro