]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Include/Protocol/FileExplorer.h
MdeModulePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdeModulePkg / Include / Protocol / FileExplorer.h
index 2831966edff5c36a4fd7e6fc5a7d5c3e24c96a36..43f1f398f350f4c3dbdaf24a3cab82b1d7dfbf72 100644 (file)
@@ -1,75 +1,69 @@
-/** @file
-
-  This file explorer protocol defines defines a set of interfaces for 
-  how to do file explorer.
-
-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under 
-the terms and conditions of the BSD License that accompanies this distribution.  
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.                                            
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#ifndef __FILE_EXPLORER_H__
-#define __FILE_EXPLORER_H__
-
-#define EFI_FILE_EXPLORER_PROTOCOL_GUID  \
-  { 0x2C03C536, 0x4594, 0x4515, { 0x9E, 0x7A, 0xD3, 0xD2, 0x04, 0xFE, 0x13, 0x63 } }
-
-//
-// Forward reference for pure ANSI compatability
-//
-typedef struct _EFI_FILE_EXPLORER_PROTOCOL  EFI_FILE_EXPLORER_PROTOCOL;
-
-/**
-  Prototype for the next process after user chosed one file.
-
-  @param[in] FilePath     The device path of the find file.
-
-  @retval    TRUE         Need exit file explorer after do the extra task.
-  @retval    FALSE        Not need to exit file explorer after do the extra task.
-
-**/
-typedef
-BOOLEAN
-(EFIAPI *CHOOSE_HANDLER)(
-  IN EFI_DEVICE_PATH_PROTOCOL  *FilePath
-  );
-
-/**
-  Choose a file in the specified directory. 
-
-  If user input NULL for the RootDirectory, will choose file in the system.
-
-  If user input *File != NULL, function will return the allocate device path
-  info for the choosed file, caller has to free the memory after use it.
-
-  @param  RootDirectory    Pointer to the root directory.
-  @param  FileType         The file type need to choose.
-  @param  ChooseHandler    Function pointer to the extra task need to do
-                           after choose one file.
-  @param  File             Return the device path for the last time chosed file.
-
-  @retval EFI_SUCESS       Choose the file success.
-  @retval Other errors     Choose the file failed.
-**/
-typedef
-EFI_STATUS
-(EFIAPI   *CHOOSE_FILE) (
-  IN  EFI_DEVICE_PATH_PROTOCOL  *RootDirectory,
-  IN  CHAR16                    *FileType,  OPTIONAL
-  IN  CHOOSE_HANDLER            ChooseHandler,  OPTIONAL
-  OUT EFI_DEVICE_PATH_PROTOCOL  **File  OPTIONAL
-  );
-
-struct _EFI_FILE_EXPLORER_PROTOCOL {
-  CHOOSE_FILE                          ChooseFile;
-};
-
-extern EFI_GUID gEfiFileExplorerProtocolGuid;
-
-#endif
+/** @file\r
+\r
+  This file explorer protocol defines defines a set of interfaces for\r
+  how to do file explorer.\r
+\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#ifndef __FILE_EXPLORER_H__\r
+#define __FILE_EXPLORER_H__\r
+\r
+#define EFI_FILE_EXPLORER_PROTOCOL_GUID  \\r
+  { 0x2C03C536, 0x4594, 0x4515, { 0x9E, 0x7A, 0xD3, 0xD2, 0x04, 0xFE, 0x13, 0x63 } }\r
+\r
+//\r
+// Forward reference for pure ANSI compatability\r
+//\r
+typedef struct _EFI_FILE_EXPLORER_PROTOCOL  EFI_FILE_EXPLORER_PROTOCOL;\r
+\r
+/**\r
+  Prototype for the next process after user chosed one file.\r
+\r
+  @param[in] FilePath     The device path of the find file.\r
+\r
+  @retval    TRUE         Need exit file explorer after do the extra task.\r
+  @retval    FALSE        Not need to exit file explorer after do the extra task.\r
+\r
+**/\r
+typedef\r
+BOOLEAN\r
+(EFIAPI *CHOOSE_HANDLER)(\r
+  IN EFI_DEVICE_PATH_PROTOCOL  *FilePath\r
+  );\r
+\r
+/**\r
+  Choose a file in the specified directory.\r
+\r
+  If user input NULL for the RootDirectory, will choose file in the system.\r
+\r
+  If user input *File != NULL, function will return the allocate device path\r
+  info for the choosed file, caller has to free the memory after use it.\r
+\r
+  @param  RootDirectory    Pointer to the root directory.\r
+  @param  FileType         The file type need to choose.\r
+  @param  ChooseHandler    Function pointer to the extra task need to do\r
+                           after choose one file.\r
+  @param  File             Return the device path for the last time chosed file.\r
+\r
+  @retval EFI_SUCESS       Choose the file success.\r
+  @retval Other errors     Choose the file failed.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI   *CHOOSE_FILE) (\r
+  IN  EFI_DEVICE_PATH_PROTOCOL  *RootDirectory,\r
+  IN  CHAR16                    *FileType,  OPTIONAL\r
+  IN  CHOOSE_HANDLER            ChooseHandler,  OPTIONAL\r
+  OUT EFI_DEVICE_PATH_PROTOCOL  **File  OPTIONAL\r
+  );\r
+\r
+struct _EFI_FILE_EXPLORER_PROTOCOL {\r
+  CHOOSE_FILE                          ChooseFile;\r
+};\r
+\r
+extern EFI_GUID gEfiFileExplorerProtocolGuid;\r
+\r
+#endif\r