]>
Commit | Line | Data |
---|---|---|
e7c00761 ED |
1 | /** @file\r |
2 | \r | |
3 | This library class defines a set of interfaces for how to do file explorer.\r | |
4 | \r | |
5 | Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>\r | |
6 | This program and the accompanying materials are licensed and made available under \r | |
7 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
8 | The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php. \r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #ifndef __FILE_EXPLORER_LIB_H__\r | |
17 | #define __FILE_EXPLORER_LIB_H__\r | |
18 | \r | |
9e41f686 | 19 | #include <Protocol/FileExplorer.h>\r |
e7c00761 ED |
20 | \r |
21 | /**\r | |
22 | Choose a file in the specified directory. \r | |
23 | \r | |
24 | If user input NULL for the RootDirectory, will choose file in the system.\r | |
25 | \r | |
26 | If user input *File != NULL, function will return the allocate device path\r | |
27 | info for the choosed file, caller has to free the memory after use it.\r | |
28 | \r | |
29 | @param RootDirectory Pointer to the root directory.\r | |
30 | @param FileType The file type need to choose.\r | |
31 | @param ChooseHandler Function pointer to the extra task need to do\r | |
32 | after choose one file.\r | |
33 | @param File Return the device path for the last time chosed file.\r | |
34 | \r | |
35 | @retval EFI_SUCESS Choose the file success.\r | |
36 | @retval Other errors Choose the file failed.\r | |
37 | **/\r | |
38 | EFI_STATUS\r | |
39 | EFIAPI\r | |
40 | ChooseFile (\r | |
41 | IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory,\r | |
42 | IN CHAR16 *FileType, OPTIONAL\r | |
43 | IN CHOOSE_HANDLER ChooseHandler, OPTIONAL\r | |
44 | OUT EFI_DEVICE_PATH_PROTOCOL **File OPTIONAL\r | |
45 | );\r | |
46 | \r | |
47 | #endif\r |