sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10238 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-03-13 01:03:39 +00:00
parent 809bd7b3c9
commit 634366733d
5 changed files with 69 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h
View File

@@ -3,11 +3,12 @@
The lite print protocol defines only one print function to
print the format unicode string.
Copyright (c) 2006 - 2008, Intel Corporation
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
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
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.
@@ -26,17 +27,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _EFI_PRINT_PROTOCOL EFI_PRINT_PROTOCOL;
/**
Produces a Null-terminated Unicode string in an output buffer based on
a Null-terminated Unicode format string and a VA_LIST argument list
Produces a Null-terminated Unicode string in an output buffer, based on
a Null-terminated Unicode format string and a VA_LIST argument list.
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
and BufferSize.
The Unicode string is produced by parsing the format string specified by FormatString.
Arguments are pulled from the variable argument list specified by Marker based on the
contents of the format string.
The number of Unicode characters in the produced output buffer is returned not including
The number of Unicode characters in the produced output buffer is returned, not including
the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
If BufferSize is 0 or 1, then no output buffer is produced, and 0 is returned.
If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().
@@ -46,13 +47,13 @@ typedef struct _EFI_PRINT_PROTOCOL EFI_PRINT_PROTOCOL;
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string.
@param FormatString A Null-terminated Unicode format string.
@param Marker VA_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced output buffer not including the
@@ -69,9 +70,9 @@ UINTN
);
/**
The EFI_PRINT_PROTOCOL provides one service to produce a Null-terminated Unicode string
based on a Null-terminated Unicode format string and a VA_LIST argument list and fill into
the buffer as output
EFI_PRINT_PROTOCOL provides one service to produce a Null-terminated Unicode string,
based on a Null-terminated Unicode format string and a VA_LIST argument list, and fills into
the buffer as output.
**/
struct _EFI_PRINT_PROTOCOL {
UNI_VSPRINT VSPrint;