EdkCompatibilityPkg/Sample/Tools/Source/HiiPack/StringParse.h

   1 /*++
   2
   3 Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   StringParse.h
  15
  16 Abstract:
  17
  18   Prototypes and defines for the string pack parsing services.
  19
  20 --*/
  21
  22 #ifndef _STRING_PARSE_H_
  23 #define _STRING_PARSE_H_
  24
  25 STATUS
  26 StringGetPack (
  27   int                 Handle,           // matches handle passed in with StringParsePack()
  28   EFI_HII_STRING_PACK **StringPack,     // returned pointer to string pack
  29   int                 *StringPackSize,  // sizeof buffer pointed to by StringPack
  30   int                 *NumStringPacks,  // in the array pointed to by StringPack
  31   EFI_GUID            *FormsetGuid,
  32   EFI_GUID            *PackageGuid
  33   )
  34 /*++
  35
  36 Routine Description:
  37
  38   GC_TODO: Add function description
  39
  40 Arguments:
  41
  42   Handle          - GC_TODO: add argument description
  43   StringPack      - GC_TODO: add argument description
  44   StringPackSize  - GC_TODO: add argument description
  45   NumStringPacks  - GC_TODO: add argument description
  46   FormsetGuid     - GC_TODO: add argument description
  47   PackageGuid     - GC_TODO: add argument description
  48
  49 Returns:
  50
  51   GC_TODO: add return values
  52
  53 --*/
  54 ;
  55
  56 STATUS
  57 StringParsePack (
  58   int                   Handle,
  59   EFI_HII_STRING_PACK   *StringPack,
  60   EFI_GUID              *FormsetGuid,
  61   EFI_GUID              *PackageGuid
  62   )
  63 /*++
  64
  65 Routine Description:
  66
  67   GC_TODO: Add function description
  68
  69 Arguments:
  70
  71   Handle      - GC_TODO: add argument description
  72   StringPack  - GC_TODO: add argument description
  73   FormsetGuid - GC_TODO: add argument description
  74   PackageGuid - GC_TODO: add argument description
  75
  76 Returns:
  77
  78   GC_TODO: add return values
  79
  80 --*/
  81 ;
  82
  83 STATUS
  84 StringInit (
  85   VOID
  86   )
  87 /*++
  88
  89 Routine Description:
  90
  91   GC_TODO: Add function description
  92
  93 Arguments:
  94
  95   None
  96
  97 Returns:
  98
  99   GC_TODO: add return values
 100
 101 --*/
 102 ;
 103
 104 STATUS
 105 StringEnd (
 106   VOID
 107   )
 108 /*++
 109
 110 Routine Description:
 111
 112   GC_TODO: Add function description
 113
 114 Arguments:
 115
 116   None
 117
 118 Returns:
 119
 120   GC_TODO: add return values
 121
 122 --*/
 123 ;
 124
 125 #endif // #ifndef _STRING_PARSE_H_