Función SetFirmwareEnvironmentVariableA (winbase.h)

Establece el valor de la variable de entorno de firmware especificada.

Sintaxis

BOOL SetFirmwareEnvironmentVariableA(
  [in] LPCSTR lpName,
  [in] LPCSTR lpGuid,
  [in] PVOID  pValue,
  [in] DWORD  nSize
);

Parámetros

[in] lpName

Nombre de la variable de entorno de firmware. El puntero no debe ser NULL.

[in] lpGuid

GUID que representa el espacio de nombres de la variable de entorno de firmware. El GUID debe ser una cadena con el formato "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}". Si el sistema no admite espacios de nombres basados en GUID, este parámetro se omite.

[in] pValue

Puntero al nuevo valor de la variable de entorno de firmware.

[in] nSize

Tamaño del búfer de pBuffer , en bytes. Si este parámetro es cero, se elimina la variable de entorno de firmware.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError. Los posibles códigos de error incluyen ERROR_INVALID_FUNCTION.

Comentarios

A partir de Windows 10, versión 1803, las aplicaciones universales de Windows pueden leer y escribir variables de firmware UEFI. Consulta Access UEFI firmware variables from a Universal Windows App (Acceder a variables de firmware ueFI desde una aplicación universal de Windows) para obtener más información.

A partir de Windows 10, versión 1803, también se admite la lectura de variables de firmware ueFI desde controladores de User-Mode Driver Framework (UMDF). No se admite la escritura de variables de firmware UEFI desde controladores UMDF.

Para escribir una variable de entorno de firmware, la cuenta de usuario en la que se ejecuta la aplicación debe tener el privilegio SE_SYSTEM_ENVIRONMENT_NAME . Una aplicación universal de Windows debe ejecutarse desde una cuenta de administrador y seguir los requisitos descritos en Acceso a variables de firmware UEFI desde una aplicación universal de Windows.

El firmware de arranque determina el conjunto exacto de variables de entorno de firmware. El firmware también especifica la ubicación de estas variables de entorno. Por ejemplo, en un sistema basado en UEFI, NVRAM contiene variables de entorno de firmware que especifican la configuración de arranque del sistema. Para obtener información sobre variables específicas usadas, consulte la especificación UEFI. Para obtener más información sobre UEFI y Windows, consulte UEFI y Windows.

Las variables de firmware no se admiten en un sistema heredado basado en BIOS. La función SetFirmwareEnvironmentVariable siempre producirá un error en un sistema heredado basado en BIOS, o si Windows se instaló con bios heredado en un sistema que admita BIOS heredado y UEFI. Para identificar estas condiciones, llame a la función con un nombre de entorno de firmware ficticio, como una cadena vacía ("") para el parámetro lpName y un GUID ficticio, como "{00000000-0000-0000-0000-000000000000}" para el parámetro lpGuid . En un sistema heredado basado en BIOS, o en un sistema que admita BIOS heredado y UEFI donde Windows se instaló con BIOS heredado, la función producirá un error con ERROR_INVALID_FUNCTION. En un sistema basado en UEFI, la función producirá un error específico del firmware, como ERROR_NOACCESS, para indicar que el espacio de nombres GUID ficticio no existe.

SetFirmwareEnvironmentVariable es el equivalente en modo de usuario de la rutina del modo kernel-mode exSetFirmwareEnvironmentVariable .

Nota

El encabezado winbase.h define SetFirmwareEnvironmentVariable 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 Vista, Windows XP con SP1 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2003 [aplicaciones de escritorio | aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	winbase.h (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll

Vea también

Acceso a variables de firmware UEFI desde una aplicación universal de Windows

GetFirmwareEnvironmentVariable

SetFirmwareEnvironmentVariableEx

Funciones de información del sistema