Función GetFirmwareEnvironmentVariableA (winbase.h)

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

Sintaxis

DWORD GetFirmwareEnvironmentVariableA(
  [in]  LPCSTR lpName,
  [in]  LPCSTR lpGuid,
  [out] PVOID  pBuffer,
  [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}", donde 'x' representa un valor hexadecimal.

[out] pBuffer

Puntero a un búfer que recibe el valor de la variable de entorno de firmware especificada.

[in] nSize

Tamaño del búfer de pBuffer , en bytes.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es el número de bytes almacenados en el búfer de pBuffer .

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 unified Extensible Firmware Interface (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.

Para leer 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.

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

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 GetFirmwareEnvironmentVariable siempre producirá un error en un sistema basado en BIOS heredado, 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.

Si va a crear una aplicación de copia de seguridad, puede usar esta función para guardar toda la configuración de arranque del sistema para que se puedan restaurar mediante la función SetFirmwareEnvironmentVariable si es necesario.

GetFirmwareEnvironmentVariable es el equivalente en modo de usuario de la rutina del modo kernel-mode exGetFirmwareEnvironmentVariable .

Nota

El encabezado winbase.h define GetFirmwareEnvironmentVariable 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

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

GetFirmwareEnvironmentVariableEx

SetFirmwareEnvironmentVariable

Funciones de información del sistema