MdeModulePkg/Include/Library/PlatformVarCleanupLib.h File Reference


Enumerations

enum  VAR_CLEANUP_TYPE { VarCleanupAll, VarCleanupManually, VarCleanupMax }

Functions

VAR_ERROR_FLAG EFIAPI GetLastBootVarErrorFlag ()
EFI_STATUS EFIAPI PlatformVarCleanup (IN VAR_ERROR_FLAG Flag, IN VAR_CLEANUP_TYPE Type)

Detailed Description

The library class provides platform variable cleanup services.

Copyright (c) 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Enumeration Type Documentation

Enumerator:
VarCleanupAll 
VarCleanupManually 
VarCleanupMax 


Function Documentation

VAR_ERROR_FLAG EFIAPI GetLastBootVarErrorFlag (  ) 

Get last boot variable error flag.

Returns:
Last boot variable error flag.

EFI_STATUS EFIAPI PlatformVarCleanup ( IN VAR_ERROR_FLAG  Flag,
IN VAR_CLEANUP_TYPE  Type 
)

Platform variable cleanup.

Parameters:
[in] Flag Variable error flag.
[in] Type Variable cleanup type. If it is VarCleanupManually, the interface must be called after console connected.
Return values:
EFI_SUCCESS No error or error processed.
EFI_UNSUPPORTED The specified Flag or Type is not supported. For example, system error may be not supported to process and Platform should have mechanism to reset system to manufacture mode. Another, if system and user variables are wanted to be distinguished to process, the interface must be called after EndOfDxe.
EFI_OUT_OF_RESOURCES Not enough resource to process the error.
EFI_INVALID_PARAMETER The specified Flag or Type is an invalid value.
Others Other failure occurs.


Generated on Thu Sep 24 23:30:15 2015 for MdeModulePkg[ALL] by  doxygen 1.5.7.1