tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update string function comments 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8157 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
eric_tian 2009-04-23 07:23:37 +00:00
parent 4324075fce
commit 14c6da21c6
2 changed files with 65 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Include/Library/EdkIIGlueBaseLib.h
View File

@ -1,6 +1,6 @@
/*++ /*++
Copyright (c) 2004 - 2006, Intel Corporation Copyright (c) 2004 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -226,9 +226,11 @@ GlueStrCpy (
If Length > 0 and Source is NULL, then ASSERT(). If Length > 0 and Source is NULL, then ASSERT().
If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT(). If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
If Source and Destination overlap, then ASSERT(). If Source and Destination overlap, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
PcdMaximumUnicodeStringLength, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Source contains more than If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
Null-terminator, then ASSERT(). then ASSERT().
@param Destination Pointer to a Null-terminated Unicode string. @param Destination Pointer to a Null-terminated Unicode string.
@param Source Pointer to a Null-terminated Unicode string. @param Source Pointer to a Null-terminated Unicode string.
@ -346,12 +348,14 @@ GlueStrCmp (
If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT(). If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
If Length > 0 and SecondString is NULL, then ASSERT(). If Length > 0 and SecondString is NULL, then ASSERT().
If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT(). If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
than PcdMaximumUnicodeStringLength Unicode characters not including the PcdMaximumUnicodeStringLength, then ASSERT().
Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more than
If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
than PcdMaximumUnicodeStringLength Unicode characters not including the then ASSERT().
Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more than
PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
then ASSERT().
@param FirstString Pointer to a Null-terminated Unicode string. @param FirstString Pointer to a Null-terminated Unicode string.
@param SecondString Pointer to a Null-terminated Unicode string. @param SecondString Pointer to a Null-terminated Unicode string.
@ -428,16 +432,17 @@ GlueStrCat (
If Length > 0 and Source is NULL, then ASSERT(). If Length > 0 and Source is NULL, then ASSERT().
If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT(). If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
If Source and Destination overlap, then ASSERT(). If Source and Destination overlap, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
PcdMaximumUnicodeStringLength, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Destination contains more If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
than PcdMaximumUnicodeStringLength Unicode characters not including the than PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Source contains more than If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
and Source results in a Unicode string with more than and Source results in a Unicode string with more than PcdMaximumUnicodeStringLength
PcdMaximumUnicodeStringLength Unicode characters not including the Unicode characters, not including the Null-terminator, then ASSERT().
Null-terminator, then ASSERT().
@param Destination Pointer to a Null-terminated Unicode string. @param Destination Pointer to a Null-terminated Unicode string.
@param Source Pointer to a Null-terminated Unicode string. @param Source Pointer to a Null-terminated Unicode string.
@ -735,8 +740,10 @@ AsciiStrCpy (
If Destination is NULL, then ASSERT(). If Destination is NULL, then ASSERT().
If Source is NULL, then ASSERT(). If Source is NULL, then ASSERT().
If Source and Destination overlap, then ASSERT(). If Source and Destination overlap, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Length is greater than
PcdMaximumAsciiStringLength, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Source contains more than If PcdMaximumAsciiStringLength is not zero, and Source contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
@param Destination Pointer to a Null-terminated ASCII string. @param Destination Pointer to a Null-terminated ASCII string.
@ -887,11 +894,13 @@ AsciiStriCmp (
If Length > 0 and FirstString is NULL, then ASSERT(). If Length > 0 and FirstString is NULL, then ASSERT().
If Length > 0 and SecondString is NULL, then ASSERT(). If Length > 0 and SecondString is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero and FirstString contains more than If PcdMaximumAsciiStringLength is not zero, and Length is greater than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and FirstString contains more than
PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
If PcdMaximumAsciiStringLength is not zero and SecondString contains more than If PcdMaximumAsciiStringLength is not zero, and SecondString contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
@param FirstString Pointer to a Null-terminated ASCII string. @param FirstString Pointer to a Null-terminated ASCII string.
@ -961,15 +970,17 @@ AsciiStrCat (
If Length > 0 and Destination is NULL, then ASSERT(). If Length > 0 and Destination is NULL, then ASSERT().
If Length > 0 and Source is NULL, then ASSERT(). If Length > 0 and Source is NULL, then ASSERT().
If Source and Destination overlap, then ASSERT(). If Source and Destination overlap, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Length is greater than
PcdMaximumAsciiStringLength, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Destination contains more than If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Source contains more than If PcdMaximumAsciiStringLength is not zero, and Source contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
Source results in a ASCII string with more than PcdMaximumAsciiStringLength Source results in a ASCII string with more than PcdMaximumAsciiStringLength
ASCII characters not including the Null-terminator, then ASSERT(). ASCII characters, not including the Null-terminator, then ASSERT().
@param Destination Pointer to a Null-terminated ASCII string. @param Destination Pointer to a Null-terminated ASCII string.
@param Source Pointer to a Null-terminated ASCII string. @param Source Pointer to a Null-terminated ASCII string.

53
EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/BaseLib/String.c
View File

@ -92,9 +92,11 @@ GlueStrCpy (
If Length > 0 and Source is NULL, then ASSERT(). If Length > 0 and Source is NULL, then ASSERT().
If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT(). If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
If Source and Destination overlap, then ASSERT(). If Source and Destination overlap, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
PcdMaximumUnicodeStringLength, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Source contains more than If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
Null-terminator, then ASSERT(). then ASSERT().
@param Destination Pointer to a Null-terminated Unicode string. @param Destination Pointer to a Null-terminated Unicode string.
@param Source Pointer to a Null-terminated Unicode string. @param Source Pointer to a Null-terminated Unicode string.
@ -271,12 +273,14 @@ GlueStrCmp (
If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT(). If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
If Length > 0 and SecondString is NULL, then ASSERT(). If Length > 0 and SecondString is NULL, then ASSERT().
If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT(). If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
than PcdMaximumUnicodeStringLength Unicode characters not including the PcdMaximumUnicodeStringLength, then ASSERT().
Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more than
If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
than PcdMaximumUnicodeStringLength Unicode characters not including the then ASSERT().
Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more than
PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
then ASSERT().
@param FirstString Pointer to a Null-terminated Unicode string. @param FirstString Pointer to a Null-terminated Unicode string.
@param SecondString Pointer to a Null-terminated Unicode string. @param SecondString Pointer to a Null-terminated Unicode string.
@ -381,16 +385,17 @@ GlueStrCat (
If Length > 0 and Source is NULL, then ASSERT(). If Length > 0 and Source is NULL, then ASSERT().
If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT(). If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
If Source and Destination overlap, then ASSERT(). If Source and Destination overlap, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
PcdMaximumUnicodeStringLength, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Destination contains more If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
than PcdMaximumUnicodeStringLength Unicode characters not including the than PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Source contains more than If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT(). Null-terminator, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
and Source results in a Unicode string with more than and Source results in a Unicode string with more than PcdMaximumUnicodeStringLength
PcdMaximumUnicodeStringLength Unicode characters not including the Unicode characters, not including the Null-terminator, then ASSERT().
Null-terminator, then ASSERT().
@param Destination Pointer to a Null-terminated Unicode string. @param Destination Pointer to a Null-terminated Unicode string.
@param Source Pointer to a Null-terminated Unicode string. @param Source Pointer to a Null-terminated Unicode string.
@ -1135,8 +1140,10 @@ AsciiStrCpy (
If Destination is NULL, then ASSERT(). If Destination is NULL, then ASSERT().
If Source is NULL, then ASSERT(). If Source is NULL, then ASSERT().
If Source and Destination overlap, then ASSERT(). If Source and Destination overlap, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Length is greater than
PcdMaximumAsciiStringLength, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Source contains more than If PcdMaximumAsciiStringLength is not zero, and Source contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
@param Destination Pointer to a Null-terminated ASCII string. @param Destination Pointer to a Null-terminated ASCII string.
@ -1412,11 +1419,13 @@ AsciiStriCmp (
If FirstString is NULL, then ASSERT(). If FirstString is NULL, then ASSERT().
If SecondString is NULL, then ASSERT(). If SecondString is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero and FirstString contains more than If PcdMaximumAsciiStringLength is not zero, and Length is greater than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and FirstString contains more than
PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
If PcdMaximumAsciiStringLength is not zero and SecondString contains more than If PcdMaximumAsciiStringLength is not zero, and SecondString contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
@param FirstString Pointer to a Null-terminated ASCII string. @param FirstString Pointer to a Null-terminated ASCII string.
@ -1514,15 +1523,17 @@ AsciiStrCat (
If Destination is NULL, then ASSERT(). If Destination is NULL, then ASSERT().
If Source is NULL, then ASSERT(). If Source is NULL, then ASSERT().
If Source and Destination overlap, then ASSERT(). If Source and Destination overlap, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Length is greater than
PcdMaximumAsciiStringLength, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Destination contains more than If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Source contains more than If PcdMaximumAsciiStringLength is not zero, and Source contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT(). then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
Source results in a ASCII string with more than PcdMaximumAsciiStringLength Source results in a ASCII string with more than PcdMaximumAsciiStringLength
ASCII characters not including the Null-terminator, then ASSERT(). ASCII characters, not including the Null-terminator, then ASSERT().
@param Destination Pointer to a Null-terminated ASCII string. @param Destination Pointer to a Null-terminated ASCII string.
@param Source Pointer to a Null-terminated ASCII string. @param Source Pointer to a Null-terminated ASCII string.