MdeModulePkg: Change OPTIONAL keyword usage style

[mirror_edk2.git] / MdeModulePkg / Include / Library / FileExplorerLib.h

/** @file\r
\r
  This library class defines a set of interfaces for how to do file explorer.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __FILE_EXPLORER_LIB_H__\r
#define __FILE_EXPLORER_LIB_H__\r
\r
#include <Protocol/FileExplorer.h>\r
\r
/**\r
  Choose a file in the specified directory.\r
\r
  If user input NULL for the RootDirectory, will choose file in the system.\r
\r
  If user input *File != NULL, function will return the allocate device path\r
  info for the choosed file, caller has to free the memory after use it.\r
\r
  @param  RootDirectory    Pointer to the root directory.\r
  @param  FileType         The file type need to choose.\r
  @param  ChooseHandler    Function pointer to the extra task need to do\r
                           after choose one file.\r
  @param  File             Return the device path for the last time chosed file.\r
\r
  @retval EFI_SUCESS       Choose the file success.\r
  @retval Other errors     Choose the file failed.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ChooseFile (\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *RootDirectory,\r
  IN  CHAR16                    *FileType   OPTIONAL,\r
  IN  CHOOSE_HANDLER            ChooseHandler   OPTIONAL,\r
  OUT EFI_DEVICE_PATH_PROTOCOL  **File  OPTIONAL\r
  );\r
\r
#endif\r