]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SimpleFileSystem.h
Grammatical and disclaimer changes (does not follow internal C coding stds.)
[mirror_edk2.git] / MdePkg / Include / Protocol / SimpleFileSystem.h
index 3f7f98d8fee0acba50c3588d315c93d8f91d56c8..dd79c5054aeef7638e88c779bf26d174aab340c4 100644 (file)
@@ -7,14 +7,14 @@
 \r
   UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem.\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation                                                         \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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
@@ -52,9 +52,9 @@ typedef EFI_FILE_PROTOCOL                 EFI_FILE;
   @retval EFI_UNSUPPORTED      This volume does not support the file system.\r
   @retval EFI_NO_MEDIA         The device has no media.\r
   @retval EFI_DEVICE_ERROR     The device reported an error.\r
-  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
-  @retval EFI_ACCESS_DENIED    The service denied access to the file\r
-  @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources\r
+  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+  @retval EFI_ACCESS_DENIED    The service denied access to the file.\r
+  @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.\r
 \r
 **/\r
 typedef\r
@@ -84,20 +84,20 @@ struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {
 /**\r
   Opens a new file relative to the source file's location.\r
 \r
-  @param  This       Protocol instance pointer.\r
-  @param  NewHandle  Returns File Handle for FileName\r
-  @param  FileName   Null terminated string. "\", ".", and ".." are supported\r
+  @param  This       The protocol instance pointer.\r
+  @param  NewHandle  Returns File Handle for FileName.\r
+  @param  FileName   Null terminated string. "\", ".", and ".." are supported.\r
   @param  OpenMode   Open mode for file.\r
-  @param  Attributes Only used for EFI_FILE_MODE_CREATE\r
+  @param  Attributes Only used for EFI_FILE_MODE_CREATE.\r
 \r
   @retval EFI_SUCCESS          The device was opened.\r
-  @retval EFI_NOT_FOUND        The specified file could not be found on the device\r
+  @retval EFI_NOT_FOUND        The specified file could not be found on the device.\r
   @retval EFI_NO_MEDIA         The device has no media.\r
-  @retval EFI_MEDIA_CHANGED    The media has changed\r
+  @retval EFI_MEDIA_CHANGED    The media has changed.\r
   @retval EFI_DEVICE_ERROR     The device reported an error.\r
-  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
-  @retval EFI_ACCESS_DENIED    The service denied access to the file\r
-  @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources\r
+  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+  @retval EFI_ACCESS_DENIED    The service denied access to the file.\r
+  @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.\r
   @retval EFI_VOLUME_FULL      The volume is full.\r
 \r
 **/\r
@@ -144,12 +144,12 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Close and delete the file handle\r
+  Close and delete the file handle.\r
 \r
   @param  This                     Protocol instance pointer.\r
                                    \r
   @retval EFI_SUCCESS              The device was opened.\r
-  @retval EFI_WARN_DELETE_FAILURE  The handle was closed but the file was not deleted\r
+  @retval EFI_WARN_DELETE_FAILURE  The handle was closed but the file was not deleted.\r
 \r
 **/\r
 typedef\r
@@ -166,10 +166,10 @@ EFI_STATUS
   @param  Buffer     The buffer in which data is read.\r
 \r
   @retval EFI_SUCCESS          Data was read.\r
-  @retval EFI_NO_MEDIA         The device has no media\r
-  @retval EFI_DEVICE_ERROR     The device reported an error\r
-  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
-  @retval EFI_BUFFER_TO_SMALL  BufferSize is too small. BufferSize contains required size\r
+  @retval EFI_NO_MEDIA         The device has no media.\r
+  @retval EFI_DEVICE_ERROR     The device reported an error.\r
+  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+  @retval EFI_BUFFER_TO_SMALL  BufferSize is too small. BufferSize contains required size.\r
 \r
 **/\r
 typedef\r
@@ -188,14 +188,14 @@ EFI_STATUS
   @param  Buffer     The buffer in which data to write.\r
 \r
   @retval EFI_SUCCESS          Data was written.\r
-  @retval EFI_UNSUPPORT        Writes to Open directory are not supported\r
-  @retval EFI_NO_MEDIA         The device has no media\r
-  @retval EFI_DEVICE_ERROR     The device reported an error\r
-  @retval EFI_DEVICE_ERROR     An attempt was made to write to a deleted file\r
-  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
-  @retval EFI_WRITE_PROTECTED  The device is write protected\r
-  @retval EFI_ACCESS_DENIED    The file was open for read only\r
-  @retval EFI_VOLUME_FULL      The volume is full\r
+  @retval EFI_UNSUPPORT        Writes to Open directory are not supported.\r
+  @retval EFI_NO_MEDIA         The device has no media.\r
+  @retval EFI_DEVICE_ERROR     The device reported an error.\r
+  @retval EFI_DEVICE_ERROR     An attempt was made to write to a deleted file.\r
+  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+  @retval EFI_WRITE_PROTECTED  The device is write protected.\r
+  @retval EFI_ACCESS_DENIED    The file was open for read only.\r
+  @retval EFI_VOLUME_FULL      The volume is full.\r
 \r
 **/\r
 typedef\r
@@ -210,7 +210,7 @@ EFI_STATUS
   Set a files current position\r
 \r
   @param  This            Protocol instance pointer.\r
-  @param  Position        Byte position from the start of the file\r
+  @param  Position        Byte position from the start of the file.\r
                           \r
   @retval EFI_SUCCESS     Data was written.\r
   @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
@@ -227,10 +227,10 @@ EFI_STATUS
   Get a file's current position\r
 \r
   @param  This            Protocol instance pointer.\r
-  @param  Position        Byte position from the start of the file\r
+  @param  Position        Byte position from the start of the file.\r
                           \r
   @retval EFI_SUCCESS     Data was written.\r
-  @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
+  @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open..\r
 \r
 **/\r
 typedef\r
@@ -241,21 +241,21 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Get information about a file\r
+  Get information about a file.\r
 \r
   @param  This            Protocol instance pointer.\r
-  @param  InformationType Type of info to return in Buffer\r
+  @param  InformationType Type of information to return in Buffer.\r
   @param  BufferSize      On input size of buffer, on output amount of data in buffer.\r
   @param  Buffer          The buffer to return data.\r
 \r
   @retval EFI_SUCCESS          Data was returned.\r
-  @retval EFI_UNSUPPORT        InformationType is not supported\r
-  @retval EFI_NO_MEDIA         The device has no media\r
-  @retval EFI_DEVICE_ERROR     The device reported an error\r
-  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
-  @retval EFI_WRITE_PROTECTED  The device is write protected\r
-  @retval EFI_ACCESS_DENIED    The file was open for read only\r
-  @retval EFI_BUFFER_TOO_SMALL Buffer was too small, required size returned in BufferSize\r
+  @retval EFI_UNSUPPORT        InformationType is not supported.\r
+  @retval EFI_NO_MEDIA         The device has no media.\r
+  @retval EFI_DEVICE_ERROR     The device reported an error.\r
+  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+  @retval EFI_WRITE_PROTECTED  The device is write protected.\r
+  @retval EFI_ACCESS_DENIED    The file was open for read only.\r
+  @retval EFI_BUFFER_TOO_SMALL Buffer was too small; required size returned in BufferSize.\r
 \r
 **/\r
 typedef\r
@@ -271,17 +271,17 @@ EFI_STATUS
   Set information about a file\r
 \r
   @param  File            Protocol instance pointer.\r
-  @param  InformationType Type of info in Buffer\r
+  @param  InformationType Type of information in Buffer.\r
   @param  BufferSize      Size of buffer.\r
   @param  Buffer          The data to write.\r
 \r
   @retval EFI_SUCCESS          Data was returned.\r
-  @retval EFI_UNSUPPORT        InformationType is not supported\r
-  @retval EFI_NO_MEDIA         The device has no media\r
-  @retval EFI_DEVICE_ERROR     The device reported an error\r
-  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
-  @retval EFI_WRITE_PROTECTED  The device is write protected\r
-  @retval EFI_ACCESS_DENIED    The file was open for read only\r
+  @retval EFI_UNSUPPORT        InformationType is not supported.\r
+  @retval EFI_NO_MEDIA         The device has no media.\r
+  @retval EFI_DEVICE_ERROR     The device reported an error.\r
+  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+  @retval EFI_WRITE_PROTECTED  The device is write protected.\r
+  @retval EFI_ACCESS_DENIED    The file was open for read only.\r
 \r
 **/\r
 typedef\r
@@ -294,18 +294,18 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Flush data back for the file handle\r
+  Flush data back for the file handle.\r
 \r
   @param  This Protocol instance pointer.\r
 \r
   @retval EFI_SUCCESS          Data was written.\r
-  @retval EFI_UNSUPPORT        Writes to Open directory are not supported\r
-  @retval EFI_NO_MEDIA         The device has no media\r
-  @retval EFI_DEVICE_ERROR     The device reported an error\r
-  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
-  @retval EFI_WRITE_PROTECTED  The device is write protected\r
-  @retval EFI_ACCESS_DENIED    The file was open for read only\r
-  @retval EFI_VOLUME_FULL      The volume is full\r
+  @retval EFI_UNSUPPORT        Writes to Open directory are not supported.\r
+  @retval EFI_NO_MEDIA         The device has no media.\r
+  @retval EFI_DEVICE_ERROR     The device reported an error.\r
+  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+  @retval EFI_WRITE_PROTECTED  The device is write protected.\r
+  @retval EFI_ACCESS_DENIED    The file was open for read only.\r
+  @retval EFI_VOLUME_FULL      The volume is full.\r
 \r
 **/\r
 typedef\r