MdeModulePkg[all]  0.98
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
FileExplorer.h File Reference

Data Structures

struct  _EFI_FILE_EXPLORER_PROTOCOL
 

Macros

#define EFI_FILE_EXPLORER_PROTOCOL_GUID   { 0x2C03C536, 0x4594, 0x4515, { 0x9E, 0x7A, 0xD3, 0xD2, 0x04, 0xFE, 0x13, 0x63 } }
 

Typedefs

typedef struct
_EFI_FILE_EXPLORER_PROTOCOL 
EFI_FILE_EXPLORER_PROTOCOL
 
typedef BOOLEAN(EFIAPI * CHOOSE_HANDLER )(IN EFI_DEVICE_PATH_PROTOCOL *FilePath)
 
typedef IN CHAR16 * FileType
 
typedef IN CHAR16 IN CHOOSE_HANDLER ChooseHandler
 
typedef IN CHAR16 IN
CHOOSE_HANDLER OUT
EFI_DEVICE_PATH_PROTOCOL ** 
File
 

Functions

typedef EFI_STATUS (EFIAPI *CHOOSE_FILE)(IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory
 

Variables

EFI_GUID gEfiFileExplorerProtocolGuid
 

Detailed Description

This file explorer protocol defines defines a set of interfaces for how to do file explorer.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EFI_FILE_EXPLORER_PROTOCOL_GUID   { 0x2C03C536, 0x4594, 0x4515, { 0x9E, 0x7A, 0xD3, 0xD2, 0x04, 0xFE, 0x13, 0x63 } }

Typedef Documentation

typedef BOOLEAN(EFIAPI * CHOOSE_HANDLER)(IN EFI_DEVICE_PATH_PROTOCOL *FilePath)

Prototype for the next process after user chosed one file.

Parameters
[in]FilePathThe device path of the find file.
Return values
TRUENeed exit file explorer after do the extra task.
FALSENot need to exit file explorer after do the extra task.
typedef IN CHAR16 IN CHOOSE_HANDLER ChooseHandler
typedef IN CHAR16 IN CHOOSE_HANDLER OUT EFI_DEVICE_PATH_PROTOCOL** File
typedef IN CHAR16* FileType

Function Documentation

typedef EFI_STATUS ( EFIAPI *  CHOOSE_FILE)

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.

Parameters
RootDirectoryPointer to the root directory.
FileTypeThe file type need to choose.
ChooseHandlerFunction pointer to the extra task need to do after choose one file.
FileReturn the device path for the last time chosed file.
Return values
EFI_SUCESSChoose the file success.
Othererrors Choose the file failed.

Variable Documentation

EFI_GUID gEfiFileExplorerProtocolGuid