Fix a type in the directory name. Compatiblity -> Compatibility.

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / Forms.c

/**@file\r
  This file contains the form processing code to the HII database.\r
\r
Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
#include "HiiDatabase.h"\r
\r
EFI_STATUS\r
EFIAPI\r
HiiExportDatabase (\r
  IN     EFI_HII_PROTOCOL *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE    Handle,\r
  IN OUT UINTN            *BufferSize,\r
  OUT    VOID             *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function allows a program to extract a form or form package that has\r
  previously been registered with the EFI HII database.\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
{\r
  ASSERT (FALSE);\r
  return EFI_UNSUPPORTED;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetForms (\r
  IN     EFI_HII_PROTOCOL   *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE      Handle,\r
  IN     EFI_FORM_ID        FormId,\r
  IN OUT UINTN              *BufferLengthTemp,\r
  OUT    UINT8              *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function allows a program to extract a form or form package that has\r
  previously been registered with the EFI HII database.\r
\r
Arguments:\r
  This         - A pointer to the EFI_HII_PROTOCOL instance.\r
\r
  Handle       - Handle on which the form resides. Type FRAMEWORK_EFI_HII_HANDLE  is defined in\r
                 EFI_HII_PROTOCOL.NewPack() in the Packages section.\r
\r
  FormId       - The ID of the form to return. If the ID is zero, the entire form package is returned.\r
                 Type EFI_FORM_ID is defined in "Related Definitions" below.\r
\r
  BufferLength - On input, the length of the Buffer. On output, the length of the returned buffer, if\r
                 the length was sufficient and, if it was not, the length that is required to fit the\r
                 requested form(s).\r
\r
  Buffer       - The buffer designed to receive the form(s).\r
\r
Returns:\r
\r
  EFI_SUCCESS           -  Buffer filled with the requested forms. BufferLength\r
                           was updated.\r
\r
  EFI_INVALID_PARAMETER -  The handle is unknown.\r
\r
  EFI_NOT_FOUND         -  A form on the requested handle cannot be found with the\r
                           requested FormId.\r
\r
  EFI_BUFFER_TOO_SMALL  - The buffer provided was not large enough to allow the form to be stored.\r
\r
--*/\r
{\r
  ASSERT (FALSE);\r
  return EFI_UNSUPPORTED;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
HiiGetDefaultImage (\r
  IN     EFI_HII_PROTOCOL            *This,\r
  IN     FRAMEWORK_EFI_HII_HANDLE    Handle,\r
  IN     UINTN                       DefaultMask,\r
  OUT    EFI_HII_VARIABLE_PACK_LIST  **VariablePackList\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
  This function allows a program to extract the NV Image\r
  that represents the default storage image\r
\r
  Arguments:\r
    This             - A pointer to the EFI_HII_PROTOCOL instance.\r
    Handle           - The HII handle from which will have default data retrieved.\r
    UINTN            - Mask used to retrieve the default image.\r
    VariablePackList - Callee allocated, tightly-packed, link list data\r
                         structure that contain all default varaible packs\r
                         from the Hii Database.\r
\r
  Returns:\r
    EFI_NOT_FOUND         - If Hii database does not contain any default images.\r
    EFI_INVALID_PARAMETER - Invalid input parameter.\r
    EFI_SUCCESS           - Operation successful.\r
\r
--*/\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
HiiUpdateForm (\r
  IN EFI_HII_PROTOCOL       *This,\r
  IN FRAMEWORK_EFI_HII_HANDLE          Handle,\r
  IN EFI_FORM_LABEL         Label,\r
  IN BOOLEAN                AddData,\r
  IN EFI_HII_UPDATE_DATA    *Data\r
  )\r
/*++\r
\r
Routine Description:\r
  This function allows the caller to update a form that has\r
  previously been registered with the EFI HII database.\r
\r
Arguments:\r
  Handle     - Hii Handle associated with the Formset to modify\r
  Label      - Update information starting immediately after this label in the IFR\r
  AddData    - If TRUE, add data.  If FALSE, remove data\r
  Data       - If adding data, this is the pointer to the data to add\r
\r
Returns:\r
  EFI_SUCCESS - Update success.\r
  Other       - Update fail.\r
\r
--*/\r
{\r
  return EFI_SUCCESS;\r
}\r