MdeModulePkg/Include/Library/FileExplorerLib.h

   1 /** @file
   2
   3   This library class defines a set of interfaces for how to do file explorer.
   4
   5 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef __FILE_EXPLORER_LIB_H__
  11 #define __FILE_EXPLORER_LIB_H__
  12
  13 #include <Protocol/FileExplorer.h>
  14
  15 /**
  16   Choose a file in the specified directory.
  17
  18   If user input NULL for the RootDirectory, will choose file in the system.
  19
  20   If user input *File != NULL, function will return the allocate device path
  21   info for the choosed file, caller has to free the memory after use it.
  22
  23   @param  RootDirectory    Pointer to the root directory.
  24   @param  FileType         The file type need to choose.
  25   @param  ChooseHandler    Function pointer to the extra task need to do
  26                            after choose one file.
  27   @param  File             Return the device path for the last time chosed file.
  28
  29   @retval EFI_SUCESS       Choose the file success.
  30   @retval Other errors     Choose the file failed.
  31 **/
  32 EFI_STATUS
  33 EFIAPI
  34 ChooseFile (
  35   IN  EFI_DEVICE_PATH_PROTOCOL  *RootDirectory,
  36   IN  CHAR16                    *FileType   OPTIONAL,
  37   IN  CHOOSE_HANDLER            ChooseHandler   OPTIONAL,
  38   OUT EFI_DEVICE_PATH_PROTOCOL  **File  OPTIONAL
  39   );
  40
  41 #endif