Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / Include / Protocol / Print.h

/** @file\r
\r
  The lite print protocol defines only one print function to \r
  print the format unicode string.\r
\r
Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
#ifndef __PPRINT_H__\r
#define __PPRINT_H__\r
\r
#define EFI_PRINT_PROTOCOL_GUID  \\r
   { 0xdf2d868e, 0x32fc, 0x4cf0, {0x8e, 0x6b, 0xff, 0xd9, 0x5d, 0x13, 0x43, 0xd0} }\r
\r
//\r
// Forward reference for pure ANSI compatability\r
//\r
typedef struct _EFI_PRINT_PROTOCOL  EFI_PRINT_PROTOCOL;\r
\r
/**\r
  Produces a Null-terminated Unicode string in an output buffer, based on \r
  a Null-terminated Unicode format string and a VA_LIST argument list.\r
  \r
  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
  and BufferSize.  \r
  The Unicode string is produced by parsing the format string specified by FormatString.  \r
  Arguments are pulled from the variable argument list specified by Marker based on the \r
  contents of the format string.  \r
  The number of Unicode characters in the produced output buffer is returned, not including\r
  the Null-terminator.\r
  If BufferSize is 0 or 1, then no output buffer is produced, and 0 is returned.\r
\r
  If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
  If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
  If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
  If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
  ASSERT().\r
  If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
  contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
  Null-terminator, then ASSERT().\r
\r
  @param  StartOfBuffer   A pointer to the output buffer for the produced Null-terminated \r
                          Unicode string.\r
  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
  @param  FormatString    A Null-terminated Unicode format string.\r
  @param  Marker          VA_LIST marker for the variable argument list.\r
  \r
  @return The number of Unicode characters in the produced output buffer not including the\r
          Null-terminator.\r
\r
**/\r
typedef\r
UINTN\r
(EFIAPI *UNI_VSPRINT)(\r
  OUT CHAR16        *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR16  *FormatString,\r
  IN  VA_LIST       Marker\r
  );\r
\r
/**\r
   EFI_PRINT_PROTOCOL provides one service to produce a Null-terminated Unicode string,\r
   based on a Null-terminated Unicode format string and a VA_LIST argument list, and fills into \r
   the buffer as output.\r
**/\r
struct _EFI_PRINT_PROTOCOL {\r
  UNI_VSPRINT               VSPrint;\r
};\r
\r
extern EFI_GUID gEfiPrintProtocolGuid;\r
\r
#endif\r