TianoCore EDK2 master
Loading...
Searching...
No Matches
FileExplorer.h File Reference

Go to the source code of this file.

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 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)
 

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

Definition in file FileExplorer.h.

Macro Definition Documentation

◆ EFI_FILE_EXPLORER_PROTOCOL_GUID

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

Definition at line 14 of file FileExplorer.h.

Typedef Documentation

◆ CHOOSE_FILE

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)

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.

Definition at line 55 of file FileExplorer.h.

◆ CHOOSE_HANDLER

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.

Definition at line 32 of file FileExplorer.h.

◆ EFI_FILE_EXPLORER_PROTOCOL

Definition at line 20 of file FileExplorer.h.