]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdePkg/Include/Guid/FileInfo.h
Grammatical and disclaimer changes (does not follow internal C coding stds.)
[mirror_edk2.git] / MdePkg / Include / Guid / FileInfo.h
... / ...
CommitLineData
1/** @file\r
2 Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.SetInfo()\r
3 and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information.\r
4 This GUID is defined in UEFI specification.\r
5\r
6Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
7This program and the accompanying materials are licensed and made available under \r
8the terms and conditions of the BSD License that accompanies this distribution. \r
9The full text of the license may be found at\r
10http://opensource.org/licenses/bsd-license.php. \r
11 \r
12THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
13WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
14\r
15**/\r
16\r
17#ifndef __FILE_INFO_H__\r
18#define __FILE_INFO_H__\r
19\r
20#define EFI_FILE_INFO_ID \\r
21 { \\r
22 0x9576e92, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
23 }\r
24\r
25typedef struct {\r
26 ///\r
27 /// The size of the EFI_FILE_INFO structure, including the Null-terminated FileName string.\r
28 ///\r
29 UINT64 Size;\r
30 ///\r
31 /// The size of the file in bytes.\r
32 ///\r
33 UINT64 FileSize;\r
34 ///\r
35 /// PhysicalSize The amount of physical space the file consumes on the file system volume.\r
36 ///\r
37 UINT64 PhysicalSize;\r
38 ///\r
39 /// The time the file was created.\r
40 ///\r
41 EFI_TIME CreateTime;\r
42 ///\r
43 /// The time when the file was last accessed.\r
44 ///\r
45 EFI_TIME LastAccessTime;\r
46 ///\r
47 /// The time when the file's contents were last modified.\r
48 ///\r
49 EFI_TIME ModificationTime;\r
50 ///\r
51 /// The attribute bits for the file.\r
52 ///\r
53 UINT64 Attribute;\r
54 ///\r
55 /// The Null-terminated name of the file.\r
56 ///\r
57 CHAR16 FileName[1];\r
58} EFI_FILE_INFO;\r
59\r
60///\r
61/// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
62/// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
63/// be the size of the data structure without the FileName field. The following macro\r
64/// computes this size correctly no matter how big the FileName array is declared.\r
65/// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
66///\r
67#define SIZE_OF_EFI_FILE_INFO OFFSET_OF (EFI_FILE_INFO, FileName)\r
68\r
69extern EFI_GUID gEfiFileInfoGuid;\r
70\r
71#endif\r