ShellPkg/Include/Library/BcfgCommandLib.h

   1 /** @file
   2   Header file for BCFG command library.
   3
   4   Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _BCFG_COMMAND_LIB_H_
  16 #define _BCFG_COMMAND_LIB_H_
  17
  18 /**
  19   "Constructor" for the library.
  20
  21   This will register the handler for the bcfg command.
  22
  23   @param[in] ImageHandle    the image handle of the process
  24   @param[in] SystemTable    the EFI System Table pointer
  25   @param[in] Name           the profile name to use
  26
  27   @retval EFI_SUCCESS        the shell command handlers were installed sucessfully
  28   @retval EFI_UNSUPPORTED    the shell level required was not found.
  29 **/
  30 EFI_STATUS
  31 EFIAPI
  32 BcfgLibraryRegisterBcfgCommand (
  33   IN EFI_HANDLE        ImageHandle,
  34   IN EFI_SYSTEM_TABLE  *SystemTable,
  35   IN CONST CHAR16      *Name
  36   );
  37
  38 /**
  39   "Destructor" for the library.  free any resources.
  40
  41   @param ImageHandle            The image handle of the process.
  42   @param SystemTable            The EFI System Table pointer.
  43 **/
  44 EFI_STATUS
  45 EFIAPI
  46 BcfgLibraryUnregisterBcfgCommand (
  47   IN EFI_HANDLE        ImageHandle,
  48   IN EFI_SYSTEM_TABLE  *SystemTable
  49   );
  50
  51 #endif
  52