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

Go to the source code of this file.

Functions

EFI_STATUS EFIAPI ChooseFile (IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory, IN CHAR16 *FileType OPTIONAL, IN CHOOSE_HANDLER ChooseHandler OPTIONAL, OUT EFI_DEVICE_PATH_PROTOCOL **File OPTIONAL)
 

Detailed Description

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

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

Definition in file FileExplorerLib.h.

Function Documentation

◆ ChooseFile()

EFI_STATUS EFIAPI ChooseFile ( 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.

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 file success.
EFI_INVALID_PARAMETERBoth ChooseHandler and return device path are NULL One of them must not NULL.
Othererrors Choose file failed.

Definition at line 78 of file DxeFileExplorerProtocol.c.