#include <Uefi.h>
#include <Base.h>
#include <Protocol/FileExplorer.h>
#include <Library/FileExplorerLib.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>

Functions
EFI_STATUS EFIAPI	FileExplorerConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

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)

Variables
EFI_FILE_EXPLORER_PROTOCOL *	mProtocol = NULL

Detailed Description

Instance of file explorer Library based on gEfiFileExplorerProtocolGuid.

Implement the file explorer library instance by wrap the interface provided in the file explorer protocol. This protocol is defined as the internal protocol related to this implementation, not in the public spec. So, this library instance is only for this code base.

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

Definition in file DxeFileExplorerProtocol.c.

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

RootDirectory	Pointer to the root directory.
FileType	The file type need to choose.
ChooseHandler	Function pointer to the extra task need to do after choose one file.
File	Return the device path for the last time chosed file.

Return values

EFI_SUCESS	Choose file success.
EFI_INVALID_PARAMETER	Both ChooseHandler and return device path are NULL One of them must not NULL.
Other	errors Choose file failed.

Definition at line 78 of file DxeFileExplorerProtocol.c.

◆ FileExplorerConstructor()

EFI_STATUS EFIAPI FileExplorerConstructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The constructor function caches the pointer to file explorer protocol.

The constructor function locates Print2 protocol from protocol database. It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS The constructor always returns EFI_SUCCESS.

Definition at line 39 of file DxeFileExplorerProtocol.c.

Variable Documentation

◆ mProtocol

EFI_FILE_EXPLORER_PROTOCOL* mProtocol = NULL

Definition at line 23 of file DxeFileExplorerProtocol.c.