MdePkg\Library\UefiFileHandleLib: Make FileHandleWriteLine support both ASCII and...

[mirror_edk2.git] / MdePkg / Include / Library / FileHandleLib.h

diff --git a/MdePkg/Include/Library/FileHandleLib.h b/MdePkg/Include/Library/FileHandleLib.h
index bfcf8a4ee3f997169780d471f9d05eace5988e27..b5ac19ac85de4506a010d659b42889074aee524a 100644 (file)
--- a/MdePkg/Include/Library/FileHandleLib.h
+++ b/MdePkg/Include/Library/FileHandleLib.h
@@ -433,7 +433,13 @@ FileHandleReturnLine(
   );\r
 \r
 /**\r
-  Function to write a line of unicode text to a file.\r
+  Function to write a line of text to a file.\r
+  \r
+  If the file is a Unicode file (with UNICODE file tag) then write the unicode \r
+  text.\r
+  If the file is an ASCII file then write the ASCII text.\r
+  If the size of file is zero (without file tag at the beginning) then write \r
+  ASCII text as default.\r
 \r
   @param[in]     Handle         FileHandle to write to.\r
   @param[in]     Buffer         Buffer to write, if NULL the function will\r
@@ -442,6 +448,8 @@ FileHandleReturnLine(
   @retval  EFI_SUCCESS            The data was written.\r
                                   Buffer is NULL.\r
   @retval  EFI_INVALID_PARAMETER  Handle is NULL.\r
+  @retval  EFI_OUT_OF_RESOURCES   Unable to allocate temporary space for ASCII \r
+                                  string due to out of resources.\r
 \r
   @sa FileHandleWrite\r
 **/\r