Función RegSetValueA (winreg.h)

Artículo
11/20/2024

Establece los datos para el valor predeterminado o sin nombre de una clave del Registro especificada. Los datos deben ser una cadena de texto.

Nota Esta función solo se proporciona por compatibilidad con versiones de 16 bits de Windows. Las aplicaciones deben usar la función regSetValueEx .

Sintaxis

LSTATUS RegSetValueA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey,
  [in]           DWORD  dwType,
  [in]           LPCSTR 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 claves del Registro.

Este identificador lo devuelve el RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyExo función 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 una subclave del parámetro hKey. La función establece el valor predeterminado de la subclave especificada. Si lpSubKey no existe, la función la crea.

Los nombres de clave no distinguen mayúsculas de minúsculas.

Si este parámetro es null o apunta a una cadena vacía, la función establece el valor predeterminado de la clave identificada por hKey.

Para obtener más información, consulte límites de tamaño de elemento del Registro .

[in] dwType

Tipo de información que se va a almacenar. Este parámetro debe ser el tipo REG_SZ. Para almacenar otros tipos de datos, use la función RegSetValueEx.

[in] lpData

Datos que se van a almacenar. Este parámetro no puede ser NULL.

[in] cbData

Este parámetro se omite. La función calcula este valor en función del tamaño de los datos del parámetro lpData.

Valor devuelto

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

Si se produce un error en la función, 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.

Observaciones

Si la clave especificada por el parámetro lpSubKey no existe, la función RegSetValue la crea.

Si se usa la versión ANSI de esta función (llamando explícitamente a RegSetValueA o no definiendo UNICODE antes de incluir el archivo Windows.h), el parámetro lpData debe ser una cadena de caracteres ANSI. La cadena se convierte en Unicode antes de almacenarla en el Registro.

Nota

El encabezado winreg.h define RegSetValue 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 Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	winreg.h (incluya Windows.h)
biblioteca de	Advapi32.lib
DLL de	Advapi32.dll