]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Guid/FileInfo.h
Remove tabs in MdePkg source code
[mirror_edk2.git] / MdePkg / Include / Guid / FileInfo.h
index d36a39c24a18f39b59d2da4297c44b25929b0345..ad56b6e7340184266abcc62ea17d30c9b579c6fc 100644 (file)
@@ -1,13 +1,9 @@
 /** @file\r
-  SimpleFileSystem guid and data structure as defined in the EFI 1.0 specification.\r
+  Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.SetInfo()\r
+  and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information.\r
+  This GUID is defined in UEFI specification.\r
 \r
-  The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32) \r
-  file system specified in EFI 1.0. It can also be used to abstract any \r
-  file system other than FAT.\r
-\r
-  EFI 1.0 can boot from any valid EFI image contained in a SimpleFileSystem\r
-\r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
   }\r
 \r
 typedef struct {\r
+  ///\r
+  /// Size of the EFI_FILE_INFO structure, including the Nullterminated Unicode FileName string.\r
+  ///\r
   UINT64    Size;\r
+  ///\r
+  /// The size of the file in bytes.\r
+  ///\r
   UINT64    FileSize;\r
+  ///\r
+  /// PhysicalSize The amount of physical space the file consumes on the file system volume.\r
+  ///\r
   UINT64    PhysicalSize;\r
+  ///\r
+  /// The time the file was created.\r
+  ///\r
   EFI_TIME  CreateTime;\r
+  ///\r
+  /// The time when the file was last accessed.\r
+  ///\r
   EFI_TIME  LastAccessTime;\r
+  ///\r
+  /// The time when the file's contents were last modified.\r
+  ///\r
   EFI_TIME  ModificationTime;\r
+  ///\r
+  /// The attribute bits for the file.\r
+  ///\r
   UINT64    Attribute;\r
+  ///\r
+  /// The Null-terminated Unicode name of the file.\r
+  ///\r
   CHAR16    FileName[1];\r
 } EFI_FILE_INFO;\r
 \r
-//\r
-// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
-// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
-// be the size of the data structure without the FileName field.  The following macro\r
-// computes this size correctly no matter how big the FileName array is declared.\r
-// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
-//\r
-#define SIZE_OF_EFI_FILE_INFO EFI_FIELD_OFFSET (EFI_FILE_INFO, FileName)\r
+///\r
+/// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
+/// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
+/// be the size of the data structure without the FileName field.  The following macro\r
+/// computes this size correctly no matter how big the FileName array is declared.\r
+/// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
+///\r
+#define SIZE_OF_EFI_FILE_INFO OFFSET_OF (EFI_FILE_INFO, FileName)\r
 \r
 extern EFI_GUID gEfiFileInfoGuid;\r
 \r