4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI Shell protocol as defined in the UEFI Shell 2.0 specification including errata.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x6302d008, 0x7f9b, 0x4f30, { 0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// they are identical outside of the name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CONST CHAR16 *FullName; ///< Fully qualified filename.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SHELL_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns whether any script files are currently being processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE There is at least one script file active.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE No script files are active now.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Closes the file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function closes a specified file handle. All 'dirty' cached file data is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync flushed to the device, and the file is closed. In all cases, the handle is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle to be closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file closed sucessfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Creates a file or directory by name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates an empty new file or directory with the specified attributes and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returns the new file's handle. If the file already exists and is read-only, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file already existed, it is truncated and its attributes updated. If the file is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name begins with >v, then the file handle which is returned refers to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync shell environment variable with the specified name. If the shell environment variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileName Pointer to NULL-terminated file path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileAttribs The new file's attrbiutes. The different attributes are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync described in EFI_FILE_PROTOCOL.Open().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FileHandle On return, points to the created file handle or directory's handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The file path could not be opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified file could not be found on the device, or could not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file the file system on the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no medium.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync longer supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the DirName.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when the media is write-protected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The service denied access to the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_FULL The volume is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Deletes the file specified by the file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function closes and deletes a file. In all cases, the file handle is closed. If the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is returned, but the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle is still closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle to delete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was closed and deleted and the handle was closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Deletes the file specified by the file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function deletes a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileName Points to the NULL-terminated file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Disables the page break output mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enables the page break output mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute the command line.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates a nested instance of the shell and executes the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync command (CommandLine) with the specified environment (Environment). Upon return,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the status code returned by the specified command is placed in StatusCode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Environment is NULL, then the current environment is used and all changes made
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the commands executed will be reflected in the current environment. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Environment is non-NULL, then the changes made will be discarded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The CommandLine is executed from the current working directory on the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ParentImageHandle A handle of the image that is executing the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync command line.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CommandLine Points to the NULL-terminated UCS-2 encoded string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing the command line. If NULL then the command-
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync line will be empty.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Environment Points to a NULL-terminated array of environment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variables with the format 'x=y', where x is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable name and y is the value. If this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is NULL, then the current shell environment is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] ErrorCode Points to the status code returned by the command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The command executed successfully. The status code
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned by the command is pointed to by StatusCode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Out of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Find files that match a specified pattern.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function searches for all files and directories that match the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilePattern. The FilePattern can contain wild-card characters. The resulting file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information is placed in the file list FileList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync field is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FilePattern Points to a NULL-terminated shell file path, including wildcards.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FileList On return, points to the start of a file list containing the names
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of all matching files or else points to NULL if no matching files
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync were found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Files found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No files found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Find all files in a specified directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileDirHandle Handle of the directory to search.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FileList On return, points to the list of files in the directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or NULL if there are no files in the directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS File information was returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device media is not present.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Flushes data back to a device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function flushes all modified data associated with a file to a device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The handle of the file to flush.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data was flushed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no medium.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED The file or medium is write-protected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The file was opened read-only.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_FULL The volume is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Frees the file list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function cleans up the file list and any related data structures. It has no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync impact on the files themselves.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileList The file list to free. Type EFI_SHELL_FILE_INFO is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync defined in OpenFileList().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Free the file list successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the current directory on the specified device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileSystemMapping is NULL, it returns the current working directory. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileSystemMapping is not NULL, it returns the current directory associated with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileSystemMapping. In both cases, the returned name includes the file system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mapping (i.e. fs0:\current-dir).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileSystemMapping A pointer to the file system mapping. If NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the current working directory is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval !=NULL The current directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL Current directory does not exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_DEVICE_NAME_USE_COMPONENT_NAME 0x00000001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the name of the device specified by the device handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function gets the user-readable name of the device specified by the device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle. If no user-readable name could be generated, then *BestDeviceName will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL and EFI_NOT_FOUND will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DeviceHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DeviceHandle The handle of the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Flags Determines the possible sources of component names.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Language A pointer to the language specified for the device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync name, in the same format as described in the UEFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specification, Appendix M.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] BestDeviceName On return, points to the callee-allocated NULL-
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync terminated name of the device. If no device name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could be found, points to NULL. The name must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync freed by the caller...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Get the name successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Fail to get the device name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the device path from the mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function gets the device path associated with a mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Mapping A pointer to the mapping
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval !=NULL Pointer to the device path that corresponds to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device mapping. The returned pointer does not need
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL There is no device path associated with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Converts a file system style name to a device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function converts a file system style name to a device path, by replacing any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mapping references to the associated device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Path The pointer to the path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer of the file path. The file path is callee
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated and should be freed by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH) (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets either a single or list of environment variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If name is not NULL then this function returns the current value of the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Name is NULL than a list of all environment variable names is returned. Each a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL terminated string with a double NULL terminating the list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Name A pointer to the environment variable name. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Name is NULL, then the function will return all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the defined shell environment variables. In
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the case where multiple environment variables are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being returned, each variable will be terminated by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a NULL, and the list will be terminated by a double
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return A pointer to the returned string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The returned pointer does not need to be freed by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL The environment variable doesn't exist or there are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync no environment variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the file information from an open file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function allocates a buffer to store the file's information. It's the caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync responsibility to free the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle A File Handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL Cannot get the file info.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return A pointer to a buffer with file information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Converts a device path to a file system-style path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function converts a device path to a file system path by replacing part, or all, of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the device path with the file-system mapping. If there are more than one application
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file system mappings, the one that most closely matches Path will be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Path The pointer to the device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer of the NULL-terminated file path. The path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is callee-allocated and should be freed by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH) (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets a file's current position.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the current file position for the file handle. For directories, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current file position has no meaning outside of the file system driver and as such, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle on which to get the current position.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Position Byte position from the start of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Data was accessed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The request is not valid on open directories.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the size of a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the size of the file specified by FileHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The handle of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Size The size of this file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Get the file's size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Can't access the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return help information about a specific command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the help information for the specified command. The help text
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can be internal to the shell or can be from a UEFI Shell manual page.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Sections is specified, then each section name listed will be compared in a casesensitive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync manner, to the section names described in Appendix B. If the section exists,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it will be appended to the returned help text. If the section does not exist, no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information will be returned. If Sections is NULL, then all help text information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync available will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Command Points to the NULL-terminated UEFI Shell command name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Sections Points to the NULL-terminated comma-delimited
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync section names to return. If NULL, then all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sections will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] HelpText On return, points to a callee-allocated buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing all specified help text.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The help text was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned help text.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER HelpText is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND There is no help text available for Command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the mapping(s) that most closely matches the device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function gets the mapping which corresponds to the device path *DevicePath. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync there is no exact match, then the mapping which most closely matches *DevicePath
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned, and *DevicePath is updated to point to the remaining portion of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device path. If there is an exact match, the mapping is returned and *DevicePath
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the end-of-device-path node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If there are multiple map names they will be semi-colon seperated in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL-terminated string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DevicePath On entry, points to a device path pointer. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exit, updates the pointer to point to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync portion of the device path after the mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL No mapping was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval !=NULL Pointer to NULL-terminated mapping. The buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is callee allocated and should be freed by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the enable status of the page break output mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync User can use this function to determine current page break mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The page break output mode is enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The page break output mode is disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Judges whether the active shell is the root shell.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function makes the user to know that whether the active Shell is the root shell.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The active Shell is the root Shell.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The active Shell is NOT the root Shell.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Opens a file or a directory by file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function opens the specified file in the specified OpenMode and returns a file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name begins with '>v', then the file handle which is returned refers to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync shell environment variable with the specified name. If the shell environment variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name is '>i', then the file handle which is returned refers to the standard
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name is '>o', then the file handle which is returned refers to the standard
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name is '>e', then the file handle which is returned refers to the standard
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name is 'NUL', then the file handle that is returned refers to the standard NUL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileName Points to the NULL-terminated UCS-2 encoded file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FileHandle On return, points to the file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OpenMode File open mode. Either EFI_FILE_MODE_READ or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system could not be found on the device. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync longer supported. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the FileName. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when the media is write-protected. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Opens the files that match the path specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function opens all of the files specified by Path. Wildcards are processed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Path A pointer to the path string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FILE_MODE_WRITE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] FileList Points to the start of a list of files opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Create the file list successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Can't create the file list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Opens the root directory of a device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function opens the root directory of a device and returns a file handle to it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DevicePath Points to the device path corresponding to the device where the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FileHandle On exit, points to the file handle corresponding to the root directory on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Root opened successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could not be opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device had an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Opens the root directory of a device on a handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function opens the root directory of a device and returns a file handle to it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DeviceHandle The handle of the device that contains the volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FileHandle On exit, points to the file handle corresponding to the root directory on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Root opened successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could not be opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device had an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reads data from the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is not a directory, the function reads the requested number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the file at the file's current position and returns them in Buffer. If the read goes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync beyond the end of the file, the read length is truncated to the end of the file. The file's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current position is increased by the number of bytes returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is a directory, then an error is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The opened file handle for read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Buffer The buffer in which data is read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Data was read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Deletes the duplicate file names files in the given file list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileList A pointer to the first entry in the file list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Always success.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Changes a shell command alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates an alias for a shell command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Command Points to the NULL-terminated shell command or existing alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Command refers to an alias, that alias will be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FALSE and the alias already exists, then the existing alias is unchanged and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ACCESS_DENIED is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Alias being set will be stored in a non-volatile fashion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Alias created or deleted successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the command associated with a alias or a list of all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Alias Points to the NULL-terminated shell alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this parameter is NULL, then all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync aliases will be returned in ReturnedData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Volatile Upon return of a single command if TRUE indicates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this is stored in a volatile fashion. FALSE otherwise.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return If Alias is not NULL, it will return a pointer to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the NULL-terminated command for that alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Alias is NULL, ReturnedData points to a ';'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync delimited list of alias (e.g.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL An error ocurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL Alias was not a valid Alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Changes the current directory on the specified device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the FileSystem is NULL, and the directory Dir does not contain a file system's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mapped name, this function changes the current working directory. If FileSystem is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL and the directory Dir contains a mapped name, then the current file system and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the current directory on that file system are changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileSystem is not NULL, and Dir is NULL, then this changes the current working file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileSystem is not NULL and Dir is not NULL, then this function changes the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directory on the specified file system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the current working directory or the current working file system is changed then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync %cwd% environment variable will be updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileSystem A pointer to the file system's mapped name. If NULL, then the current working
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directory is changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Dir Points to the NULL-terminated directory on the device specified by FileSystem.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL Current directory does not exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The current directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the environment variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function changes the current value of the specified environment variable. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable exists and the Value is an empty string, then the environment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable is deleted. If the environment variable exists and the Value is not an empty
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string, then the value of the environment variable is changed. If the environment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable does not exist and the Value is an empty string, there is no action. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable does not exist and the Value is a non-empty string, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable is created and assigned the specified value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For a description of volatile and non-volatile environment variables, see UEFI Shell
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2.0 specification section 3.6.1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Name Points to the NULL-terminated environment variable name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Value Points to the NULL-terminated environment variable value. If the value is an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync empty string then the environment variable is deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The environment variable was successfully updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the file information to an opened file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function changes file information. All file information in the EFI_FILE_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync struct will be updated to the passed in data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle A file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileInfo Points to new file information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The information was set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no medium.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED The file or medium is write-protected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The file was opened read-only.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_FULL The volume is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE BufferSize is smaller than the size of EFI_FILE_INFO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets a file's current position.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function sets the current file position for the handle to the position supplied. With
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only absolute positioning is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported, and seeking past the end of the file is allowed (a subsequent write would
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync grow the file). Seeking to position 0xFFFFFFFFFFFFFFFF causes the current position
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be set to the end of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle on which requested position will be set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Position Byte position from the start of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Data was written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The seek request for nonzero is not valid on open directories.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates a mapping for a device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the mapping will be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Mapping Points to the NULL-terminated mapping for the device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Mapping created or deleted successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync boot service function LocateDevicePath().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Writes data to the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function writes the specified number of bytes to the file at the current file position.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The current file position is advanced the actual number of bytes written, which is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned in BufferSize. Partial writes only occur when there has been a data error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync during the write attempt (such as "volume space full"). The file automatically grows to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync hold the data, if required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Direct writes to opened directories are not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The opened file handle for writing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] BufferSize On input, size of Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buffer The buffer in which data to write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Data was written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Writes to open directory are not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED The device is write-protected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The file was open for read only.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_FULL The volume is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SHELL_GET_DEVICE_PATH_FROM_MAP GetDevicePathFromMap;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SHELL_GET_MAP_FROM_DEVICE_PATH GetMapFromDevicePath;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH GetDevicePathFromFilePath;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH GetFilePathFromDevicePath;