Función SHSetValueA (shlwapi.h)

Artículo
11/20/2024

Establece el valor de una clave del Registro.

Sintaxis

LSTATUS SHSetValueA(
  [in]           HKEY    hkey,
  [in, optional] LPCSTR  pszSubKey,
  [in, optional] LPCSTR  pszValue,
  [in]           DWORD   dwType,
  [in, optional] LPCVOID pvData,
  [in]           DWORD   cbData
);

Parámetros

[in] hkey

Tipo: HKEY de

Identificador de la clave abierta actualmente o cualquiera de los siguientes valores predefinidos.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Tipo: LPCTSTR de

Dirección de una cadena terminada en NULL que especifica el nombre de la subclave con la que está asociado un valor. Esto puede ser NULL o un puntero a una cadena vacía. En este caso, el valor se agrega a la clave identificada por el parámetro hkey .

[in, optional] pszValue

Tipo: LPCTSTR de

Dirección de una cadena terminada en NULL que especifica el valor. Este valor puede ser null.

[in] dwType

Tipo: DWORD de

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: LPCVOID

Puntero a un búfer que contiene los datos que se van a establecer para el valor especificado. Este valor puede ser null.

[in] cbData

Tipo: DWORD de

Longitud, en bytes, del búfer al que apunta el parámetro pvData. Si los datos son una cadena terminada en NULL, esta longitud incluye el carácter nulo de terminación.

Valor devuelto

Tipo: LSTATUS de

Devuelve ERROR_SUCCESS si se ejecuta correctamente; de lo contrario, 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 recuperar una descripción genérica del error.

Observaciones

Nota

El encabezado shlwapi.h define SHSetValue 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, Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	shlwapi.h
biblioteca de	Shlwapi.lib
DLL de	Shlwapi.dll (versión 4.71 o posterior)

Compartir a través de