#include <Guid/FileInfo.h>

Data Structures
struct	EFI_SHELL_FILE_INFO

struct	_EFI_SHELL_PROTOCOL

Macros
#define	EFI_SHELL_PROTOCOL_GUID

#define	EFI_DEVICE_NAME_USE_COMPONENT_NAME 0x00000001

#define	EFI_DEVICE_NAME_USE_DEVICE_PATH 0x00000002

Typedefs
typedef VOID *	SHELL_FILE_HANDLE

typedef BOOLEAN(EFIAPI *	EFI_SHELL_BATCH_IS_ACTIVE) (VOID)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_CLOSE_FILE) (IN SHELL_FILE_HANDLE FileHandle)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_CREATE_FILE) (IN CONST CHAR16 FileName, IN UINT64 FileAttribs, OUT SHELL_FILE_HANDLE FileHandle)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_DELETE_FILE) (IN SHELL_FILE_HANDLE FileHandle)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_DELETE_FILE_BY_NAME) (IN CONST CHAR16 *FileName)

typedef VOID(EFIAPI *	EFI_SHELL_DISABLE_PAGE_BREAK) (VOID)

typedef VOID(EFIAPI *	EFI_SHELL_ENABLE_PAGE_BREAK) (VOID)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_EXECUTE) (IN EFI_HANDLE ParentImageHandle, IN CHAR16 CommandLine OPTIONAL, IN CHAR16 *Environment OPTIONAL, OUT EFI_STATUS StatusCode OPTIONAL)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_FIND_FILES) (IN CONST CHAR16 FilePattern, OUT EFI_SHELL_FILE_INFO *FileList)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_FIND_FILES_IN_DIR) (IN SHELL_FILE_HANDLE FileDirHandle, OUT EFI_SHELL_FILE_INFO **FileList)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_FLUSH_FILE) (IN SHELL_FILE_HANDLE FileHandle)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_FREE_FILE_LIST) (IN EFI_SHELL_FILE_INFO **FileList)

typedef CONST CHAR16 (EFIAPI	EFI_SHELL_GET_CUR_DIR) (IN CONST CHAR16 *FileSystemMapping OPTIONAL)

typedef UINT32	EFI_SHELL_DEVICE_NAME_FLAGS

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_GET_DEVICE_NAME) (IN EFI_HANDLE DeviceHandle, IN EFI_SHELL_DEVICE_NAME_FLAGS Flags, IN CHAR8 Language, OUT CHAR16 *BestDeviceName)

typedef CONST EFI_DEVICE_PATH_PROTOCOL (EFIAPI	EFI_SHELL_GET_DEVICE_PATH_FROM_MAP) (IN CONST CHAR16 *Mapping)

typedef EFI_DEVICE_PATH_PROTOCOL (EFIAPI	EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH) (IN CONST CHAR16 *Path)

typedef CONST CHAR16 (EFIAPI	EFI_SHELL_GET_ENV) (IN CONST CHAR16 *Name OPTIONAL)

typedef CONST CHAR16 (EFIAPI	EFI_SHELL_GET_ENV_EX) (IN CONST CHAR16 Name, OUT UINT32 Attributes OPTIONAL)

typedef EFI_FILE_INFO (EFIAPI	EFI_SHELL_GET_FILE_INFO) (IN SHELL_FILE_HANDLE FileHandle)

typedef CHAR16 (EFIAPI	EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH) (IN CONST EFI_DEVICE_PATH_PROTOCOL *Path)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_GET_FILE_POSITION) (IN SHELL_FILE_HANDLE FileHandle, OUT UINT64 *Position)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_GET_FILE_SIZE) (IN SHELL_FILE_HANDLE FileHandle, OUT UINT64 *Size)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_GET_GUID_FROM_NAME) (IN CONST CHAR16 GuidName, OUT EFI_GUID Guid)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_GET_GUID_NAME) (IN CONST EFI_GUID Guid, OUT CONST CHAR16 *GuidName)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_GET_HELP_TEXT) (IN CONST CHAR16 Command, IN CONST CHAR16 Sections OPTIONAL, OUT CHAR16 **HelpText)

typedef CONST CHAR16 (EFIAPI	EFI_SHELL_GET_MAP_FROM_DEVICE_PATH) (IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath)

typedef BOOLEAN(EFIAPI *	EFI_SHELL_GET_PAGE_BREAK) (VOID)

typedef BOOLEAN(EFIAPI *	EFI_SHELL_IS_ROOT_SHELL) (VOID)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_OPEN_FILE_BY_NAME) (IN CONST CHAR16 FileName, OUT SHELL_FILE_HANDLE FileHandle, IN UINT64 OpenMode)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_OPEN_FILE_LIST) (IN CHAR16 Path, IN UINT64 OpenMode, IN OUT EFI_SHELL_FILE_INFO *FileList)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_OPEN_ROOT) (IN EFI_DEVICE_PATH_PROTOCOL DevicePath, OUT SHELL_FILE_HANDLE FileHandle)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_OPEN_ROOT_BY_HANDLE) (IN EFI_HANDLE DeviceHandle, OUT SHELL_FILE_HANDLE *FileHandle)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_READ_FILE) (IN SHELL_FILE_HANDLE FileHandle, IN OUT UINTN ReadSize, IN OUT VOID Buffer)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_REGISTER_GUID_NAME) (IN CONST EFI_GUID Guid, IN CONST CHAR16 GuidName)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_REMOVE_DUP_IN_FILE_LIST) (IN EFI_SHELL_FILE_INFO **FileList)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_SET_ALIAS) (IN CONST CHAR16 Command, IN CONST CHAR16 Alias, IN BOOLEAN Replace, IN BOOLEAN Volatile)

typedef CONST CHAR16 (EFIAPI	EFI_SHELL_GET_ALIAS) (IN CONST CHAR16 Alias, OUT BOOLEAN Volatile OPTIONAL)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_SET_CUR_DIR) (IN CONST CHAR16 FileSystem OPTIONAL, IN CONST CHAR16 Dir)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_SET_ENV) (IN CONST CHAR16 Name, IN CONST CHAR16 Value, IN BOOLEAN Volatile)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_SET_FILE_INFO) (IN SHELL_FILE_HANDLE FileHandle, IN CONST EFI_FILE_INFO *FileInfo)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_SET_FILE_POSITION) (IN SHELL_FILE_HANDLE FileHandle, IN UINT64 Position)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_SET_MAP) (IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath, IN CONST CHAR16 Mapping)

typedef EFI_STATUS(EFIAPI *	EFI_SHELL_WRITE_FILE) (IN SHELL_FILE_HANDLE FileHandle, IN OUT UINTN BufferSize, IN VOID Buffer)

typedef struct _EFI_SHELL_PROTOCOL	EFI_SHELL_PROTOCOL

Enumerations
enum	SHELL_STATUS { SHELL_SUCCESS = 0 , SHELL_LOAD_ERROR = 1 , SHELL_INVALID_PARAMETER = 2 , SHELL_UNSUPPORTED = 3 , SHELL_BAD_BUFFER_SIZE = 4 , SHELL_BUFFER_TOO_SMALL = 5 , SHELL_NOT_READY = 6 , SHELL_DEVICE_ERROR = 7 , SHELL_WRITE_PROTECTED = 8 , SHELL_OUT_OF_RESOURCES = 9 , SHELL_VOLUME_CORRUPTED = 10 , SHELL_VOLUME_FULL = 11 , SHELL_NO_MEDIA = 12 , SHELL_MEDIA_CHANGED = 13 , SHELL_NOT_FOUND = 14 , SHELL_ACCESS_DENIED = 15 , SHELL_TIMEOUT = 18 , SHELL_NOT_STARTED = 19 , SHELL_ALREADY_STARTED = 20 , SHELL_ABORTED = 21 , SHELL_INCOMPATIBLE_VERSION = 25 , SHELL_SECURITY_VIOLATION = 26 , SHELL_NOT_EQUAL = 27 }

enum	ShellVersion { SHELL_MAJOR_VERSION = 2 , SHELL_MINOR_VERSION = 2 }

Variables
EFI_GUID	gEfiShellProtocolGuid

Detailed Description

EFI Shell protocol as defined in the UEFI Shell 2.0 specification including errata.

(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Shell.h.

Macro Definition Documentation

◆ EFI_DEVICE_NAME_USE_COMPONENT_NAME

#define EFI_DEVICE_NAME_USE_COMPONENT_NAME 0x00000001

Definition at line 435 of file Shell.h.

◆ EFI_DEVICE_NAME_USE_DEVICE_PATH

#define EFI_DEVICE_NAME_USE_DEVICE_PATH 0x00000002

Definition at line 436 of file Shell.h.

◆ EFI_SHELL_PROTOCOL_GUID

#define EFI_SHELL_PROTOCOL_GUID

Value:

  { \
  0x6302d008, 0x7f9b, 0x4f30, { 0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e } \
  }

Definition at line 15 of file Shell.h.

Typedef Documentation

◆ EFI_SHELL_BATCH_IS_ACTIVE

typedef BOOLEAN(EFIAPI * EFI_SHELL_BATCH_IS_ACTIVE) (VOID)

Returns whether any script files are currently being processed.

Return values

TRUE	There is at least one script file active.
FALSE	No script files are active now.

Definition at line 169 of file Shell.h.

◆ EFI_SHELL_CLOSE_FILE

typedef EFI_STATUS(EFIAPI * EFI_SHELL_CLOSE_FILE) (IN SHELL_FILE_HANDLE FileHandle)

Closes the file handle.

This function closes a specified file handle. All 'dirty' cached file data is flushed to the device, and the file is closed. In all cases, the handle is closed.

Parameters

[in] FileHandle The file handle to be closed.

Return values

EFI_SUCCESS The file closed sucessfully.

Definition at line 186 of file Shell.h.

◆ EFI_SHELL_CREATE_FILE

typedef EFI_STATUS(EFIAPI * EFI_SHELL_CREATE_FILE) (IN CONST CHAR16 *FileName, IN UINT64 FileAttribs, OUT SHELL_FILE_HANDLE *FileHandle)

Creates a file or directory by name.

This function creates an empty new file or directory with the specified attributes and returns the new file's handle. If the file already exists and is read-only, then EFI_INVALID_PARAMETER will be returned.

If the file already existed, it is truncated and its attributes updated. If the file is created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.

If the file name begins with >v, then the file handle which is returned refers to the shell environment variable with the specified name. If the shell environment variable already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.

Parameters

[in]	FileName	Pointer to NULL-terminated file path.
[in]	FileAttribs	The new file's attrbiutes. The different attributes are described in EFI_FILE_PROTOCOL.Open().
[out]	FileHandle	On return, points to the created file handle or directory's handle.

Return values

EFI_SUCCESS	The file was opened. FileHandle points to the new file's handle.
EFI_INVALID_PARAMETER	One of the parameters has an invalid value.
EFI_UNSUPPORTED	The file path could not be opened.
EFI_NOT_FOUND	The specified file could not be found on the device, or could not file the file system on the device.
EFI_NO_MEDIA	The device has no medium.
EFI_MEDIA_CHANGED	The device has a different medium in it or the medium is no longer supported.
EFI_DEVICE_ERROR	The device reported an error or can't get the file path according the DirName.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	An attempt was made to create a file, or open a file for write when the media is write-protected.
EFI_ACCESS_DENIED	The service denied access to the file.
EFI_OUT_OF_RESOURCES	Not enough resources were available to open the file.
EFI_VOLUME_FULL	The volume is full.

Definition at line 228 of file Shell.h.

◆ EFI_SHELL_DELETE_FILE

typedef EFI_STATUS(EFIAPI * EFI_SHELL_DELETE_FILE) (IN SHELL_FILE_HANDLE FileHandle)

Deletes the file specified by the file handle.

This function closes and deletes a file. In all cases, the file handle is closed. If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is returned, but the handle is still closed.

Parameters

[in] FileHandle The file handle to delete.

Return values

EFI_SUCCESS	The file was closed and deleted and the handle was closed.
EFI_WARN_DELETE_FAILURE	The handle was closed but the file was not deleted.

Definition at line 248 of file Shell.h.

◆ EFI_SHELL_DELETE_FILE_BY_NAME

typedef EFI_STATUS(EFIAPI * EFI_SHELL_DELETE_FILE_BY_NAME) (IN CONST CHAR16 *FileName)

Deletes the file specified by the file name.

This function deletes a file.

Parameters

[in] FileName Points to the NULL-terminated file name.

Return values

EFI_SUCCESS	The file was deleted.
EFI_WARN_DELETE_FAILURE	The handle was closed but the file was not deleted.

Definition at line 264 of file Shell.h.

◆ EFI_SHELL_DEVICE_NAME_FLAGS

typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS

Definition at line 434 of file Shell.h.

◆ EFI_SHELL_DISABLE_PAGE_BREAK

typedef VOID(EFIAPI * EFI_SHELL_DISABLE_PAGE_BREAK) (VOID)

Disables the page break output mode.

Definition at line 273 of file Shell.h.

◆ EFI_SHELL_ENABLE_PAGE_BREAK

typedef VOID(EFIAPI * EFI_SHELL_ENABLE_PAGE_BREAK) (VOID)

Enables the page break output mode.

Definition at line 282 of file Shell.h.

◆ EFI_SHELL_EXECUTE

typedef EFI_STATUS(EFIAPI * EFI_SHELL_EXECUTE) (IN EFI_HANDLE *ParentImageHandle, IN CHAR16 *CommandLine OPTIONAL, IN CHAR16 **Environment OPTIONAL, OUT EFI_STATUS *StatusCode OPTIONAL)

Execute the command line.

This function creates a nested instance of the shell and executes the specified command (CommandLine) with the specified environment (Environment). Upon return, the status code returned by the specified command is placed in StatusCode.

If Environment is NULL, then the current environment is used and all changes made by the commands executed will be reflected in the current environment. If the Environment is non-NULL, then the changes made will be discarded.

The CommandLine is executed from the current working directory on the current device.

Parameters

[in]	ParentImageHandle	A handle of the image that is executing the specified command line.
[in]	CommandLine	Points to the NULL-terminated UCS-2 encoded string containing the command line. If NULL then the command- line will be empty.
[in]	Environment	Points to a NULL-terminated array of environment variables with the format 'x=y', where x is the environment variable name and y is the value. If this is NULL, then the current shell environment is used.
[out]	ErrorCode	Points to the status code returned by the command.

Return values

EFI_SUCCESS	The command executed successfully. The status code returned by the command is pointed to by StatusCode.
EFI_INVALID_PARAMETER	The parameters are invalid.
EFI_OUT_OF_RESOURCES	Out of resources.
EFI_UNSUPPORTED	Nested shell invocations are not allowed.

Definition at line 319 of file Shell.h.

◆ EFI_SHELL_FIND_FILES

typedef EFI_STATUS(EFIAPI * EFI_SHELL_FIND_FILES) (IN CONST CHAR16 *FilePattern, OUT EFI_SHELL_FILE_INFO **FileList)

Find files that match a specified pattern.

This function searches for all files and directories that match the specified FilePattern. The FilePattern can contain wild-card characters. The resulting file information is placed in the file list FileList.

The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo field is set to NULL.

Parameters

[in]	FilePattern	Points to a NULL-terminated shell file path, including wildcards.
[out]	FileList	On return, points to the start of a file list containing the names of all matching files or else points to NULL if no matching files were found.

Return values

EFI_SUCCESS	Files found.
EFI_NOT_FOUND	No files found.
EFI_NO_MEDIA	The device has no media.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.

Definition at line 349 of file Shell.h.

◆ EFI_SHELL_FIND_FILES_IN_DIR

typedef EFI_STATUS(EFIAPI * EFI_SHELL_FIND_FILES_IN_DIR) (IN SHELL_FILE_HANDLE FileDirHandle, OUT EFI_SHELL_FILE_INFO **FileList)

Find all files in a specified directory.

Parameters

[in]	FileDirHandle	Handle of the directory to search.
[out]	FileList	On return, points to the list of files in the directory or NULL if there are no files in the directory.

Return values

EFI_SUCCESS	File information was returned successfully.
EFI_VOLUME_CORRUPTED	The file system structures have been corrupted.
EFI_DEVICE_ERROR	The device reported an error.
EFI_NO_MEDIA	The device media is not present.

Definition at line 368 of file Shell.h.

◆ EFI_SHELL_FLUSH_FILE

typedef EFI_STATUS(EFIAPI * EFI_SHELL_FLUSH_FILE) (IN SHELL_FILE_HANDLE FileHandle)

Flushes data back to a device.

This function flushes all modified data associated with a file to a device.

Parameters

[in] FileHandle The handle of the file to flush.

Return values

EFI_SUCCESS	The data was flushed.
EFI_NO_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	The file or medium is write-protected.
EFI_ACCESS_DENIED	The file was opened read-only.
EFI_VOLUME_FULL	The volume is full.

Definition at line 390 of file Shell.h.

◆ EFI_SHELL_FREE_FILE_LIST

typedef EFI_STATUS(EFIAPI * EFI_SHELL_FREE_FILE_LIST) (IN EFI_SHELL_FILE_INFO **FileList)

Frees the file list.

This function cleans up the file list and any related data structures. It has no impact on the files themselves.

Parameters

[in] FileList The file list to free. Type EFI_SHELL_FILE_INFO is defined in OpenFileList().

Return values

EFI_SUCCESS Free the file list successfully.

Definition at line 407 of file Shell.h.

◆ EFI_SHELL_GET_ALIAS

typedef CONST CHAR16 *(EFIAPI * EFI_SHELL_GET_ALIAS) (IN CONST CHAR16 *Alias, OUT BOOLEAN *Volatile OPTIONAL)

This function returns the command associated with a alias or a list of all alias'.

Parameters

[in]	Alias	Points to the NULL-terminated shell alias. If this parameter is NULL, then all aliases will be returned in ReturnedData.
[out]	Volatile	Upon return of a single command if TRUE indicates this is stored in a volatile fashion. FALSE otherwise.

Returns: If Alias is not NULL, it will return a pointer to the NULL-terminated command for that alias. If Alias is NULL, ReturnedData points to a ';' delimited list of alias (e.g. ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.

Return values

NULL	An error ocurred.
NULL	Alias was not a valid Alias.

Definition at line 1016 of file Shell.h.

◆ EFI_SHELL_GET_CUR_DIR

typedef CONST CHAR16 *(EFIAPI * EFI_SHELL_GET_CUR_DIR) (IN CONST CHAR16 *FileSystemMapping OPTIONAL)

Returns the current directory on the specified device.

If FileSystemMapping is NULL, it returns the current working directory. If the FileSystemMapping is not NULL, it returns the current directory associated with the FileSystemMapping. In both cases, the returned name includes the file system mapping (i.e. fs0:\current-dir).

Note that the current directory string should exclude the tailing backslash character.

Parameters

[in] FileSystemMapping A pointer to the file system mapping. If NULL, then the current working directory is returned.

Return values

!=NULL	The current directory.
NULL	Current directory does not exist.

Definition at line 429 of file Shell.h.

◆ EFI_SHELL_GET_DEVICE_NAME

typedef EFI_STATUS(EFIAPI * EFI_SHELL_GET_DEVICE_NAME) (IN EFI_HANDLE DeviceHandle, IN EFI_SHELL_DEVICE_NAME_FLAGS Flags, IN CHAR8 *Language, OUT CHAR16 **BestDeviceName)

Gets the name of the device specified by the device handle.

This function gets the user-readable name of the device specified by the device handle. If no user-readable name could be generated, then *BestDeviceName will be NULL and EFI_NOT_FOUND will be returned.

If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on DeviceHandle.

If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle. If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.

Parameters

[in]	DeviceHandle	The handle of the device.
[in]	Flags	Determines the possible sources of component names.
[in]	Language	A pointer to the language specified for the device name, in the same format as described in the UEFI specification, Appendix M.
[out]	BestDeviceName	On return, points to the callee-allocated NULL- terminated name of the device. If no device name could be found, points to NULL. The name must be freed by the caller...

Return values

EFI_SUCCESS	Get the name successfully.
EFI_NOT_FOUND	Fail to get the device name.

Definition at line 469 of file Shell.h.

◆ EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH

typedef EFI_DEVICE_PATH_PROTOCOL *(EFIAPI * EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH) (IN CONST CHAR16 *Path)

Converts a file system style name to a device path.

This function converts a file system style name to a device path, by replacing any mapping references to the associated device path.

Parameters

[in] Path The pointer to the path.

Returns: The pointer of the file path. The file path is callee allocated and should be freed by the caller.

Definition at line 508 of file Shell.h.

◆ EFI_SHELL_GET_DEVICE_PATH_FROM_MAP

typedef CONST EFI_DEVICE_PATH_PROTOCOL *(EFIAPI * EFI_SHELL_GET_DEVICE_PATH_FROM_MAP) (IN CONST CHAR16 *Mapping)

Gets the device path from the mapping.

This function gets the device path associated with a mapping.

Parameters

[in] Mapping A pointer to the mapping

Return values

!=NULL	Pointer to the device path that corresponds to the device mapping. The returned pointer does not need to be freed.
NULL	There is no device path associated with the specified mapping.

Definition at line 491 of file Shell.h.

◆ EFI_SHELL_GET_ENV

typedef CONST CHAR16 *(EFIAPI * EFI_SHELL_GET_ENV) (IN CONST CHAR16 *Name OPTIONAL)

Gets either a single or list of environment variables.

If name is not NULL then this function returns the current value of the specified environment variable.

If Name is NULL than a list of all environment variable names is returned. Each a NULL terminated string with a double NULL terminating the list.

Parameters

[in] Name A pointer to the environment variable name. If Name is NULL, then the function will return all of the defined shell environment variables. In the case where multiple environment variables are being returned, each variable will be terminated by a NULL, and the list will be terminated by a double NULL.

Returns: A pointer to the returned string. The returned pointer does not need to be freed by the caller.

Return values

NULL	The environment variable doesn't exist or there are no environment variables.

Definition at line 537 of file Shell.h.

◆ EFI_SHELL_GET_ENV_EX

typedef CONST CHAR16 *(EFIAPI * EFI_SHELL_GET_ENV_EX) (IN CONST CHAR16 *Name, OUT UINT32 *Attributes OPTIONAL)

Gets the environment variable and Attributes, or list of environment variables. Can be used instead of GetEnv().

This function returns the current value of the specified environment variable and the Attributes. If no variable name was specified, then all of the known variables will be returned.

Parameters

[in]	Name	A pointer to the environment variable name. If Name is NULL, then the function will return all of the defined shell environment variables. In the case where multiple environment variables are being returned, each variable will be terminated by a NULL, and the list will be terminated by a double NULL.
[out]	Attributes	If not NULL, a pointer to the returned attributes bitmask for the environment variable. In the case where Name is NULL, and multiple environment variables are being returned, Attributes is undefined.

Return values

NULL	The environment variable doesn't exist.

Returns: The environment variable's value. The returned pointer does not need to be freed by the caller.

Definition at line 565 of file Shell.h.

◆ EFI_SHELL_GET_FILE_INFO

typedef EFI_FILE_INFO *(EFIAPI * EFI_SHELL_GET_FILE_INFO) (IN SHELL_FILE_HANDLE FileHandle)

Gets the file information from an open file handle.

This function allocates a buffer to store the file's information. It's the caller's responsibility to free the buffer.

Parameters

[in] FileHandle A File Handle.

Return values

NULL	Cannot get the file info.

Returns: A pointer to a buffer with file information.

Definition at line 583 of file Shell.h.

◆ EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH

typedef CHAR16 *(EFIAPI * EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH) (IN CONST EFI_DEVICE_PATH_PROTOCOL *Path)

Converts a device path to a file system-style path.

This function converts a device path to a file system path by replacing part, or all, of the device path with the file-system mapping. If there are more than one application file system mappings, the one that most closely matches Path will be used.

Parameters

[in] Path The pointer to the device path.

Returns: The pointer of the NULL-terminated file path. The path is callee-allocated and should be freed by the caller.

Definition at line 601 of file Shell.h.

◆ EFI_SHELL_GET_FILE_POSITION

typedef EFI_STATUS(EFIAPI * EFI_SHELL_GET_FILE_POSITION) (IN SHELL_FILE_HANDLE FileHandle, OUT UINT64 *Position)

Gets a file's current position.

This function returns the current file position for the file handle. For directories, the current file position has no meaning outside of the file system driver and as such, the operation is not supported.

Parameters

[in]	FileHandle	The file handle on which to get the current position.
[out]	Position	Byte position from the start of the file.

Return values

EFI_SUCCESS	Data was accessed.
EFI_UNSUPPORTED	The request is not valid on open directories.

Definition at line 620 of file Shell.h.

◆ EFI_SHELL_GET_FILE_SIZE

typedef EFI_STATUS(EFIAPI * EFI_SHELL_GET_FILE_SIZE) (IN SHELL_FILE_HANDLE FileHandle, OUT UINT64 *Size)

Gets the size of a file.

This function returns the size of the file specified by FileHandle.

Parameters

[in]	FileHandle	The handle of the file.
[out]	Size	The size of this file.

Return values

EFI_SUCCESS	Get the file's size.
EFI_DEVICE_ERROR	Can't access the file.

Definition at line 638 of file Shell.h.

◆ EFI_SHELL_GET_GUID_FROM_NAME

typedef EFI_STATUS(EFIAPI * EFI_SHELL_GET_GUID_FROM_NAME) (IN CONST CHAR16 *GuidName, OUT EFI_GUID *Guid)

Get the GUID value from a human readable name.

If GuidName is a known GUID name, then update Guid to have the correct value for that GUID.

This function is only available when the major and minor versions in the EfiShellProtocol are greater than or equal to 2 and 1, respectively.

Parameters

[in]	GuidName	A pointer to the localized name for the GUID being queried.
[out]	Guid	A pointer to the GUID structure to be filled in.

Return values

EFI_SUCCESS	The operation was successful.
EFI_INVALID_PARAMETER	Guid was NULL.
EFI_INVALID_PARAMETER	GuidName was NULL.
EFI_NOT_FOUND	GuidName is not a known GUID Name.

Definition at line 662 of file Shell.h.

◆ EFI_SHELL_GET_GUID_NAME

typedef EFI_STATUS(EFIAPI * EFI_SHELL_GET_GUID_NAME) (IN CONST EFI_GUID *Guid, OUT CONST CHAR16 **GuidName)

Get the human readable name for a GUID from the value.

If Guid is assigned a name, then update *GuidName to point to the name. The callee should not modify the value.

This function is only available when the major and minor versions in the EfiShellProtocol are greater than or equal to 2 and 1, respectively.

Parameters

[in]	Guid	A pointer to the GUID being queried.
[out]	GuidName	A pointer to a pointer the localized to name for the GUID being requested

Return values

EFI_SUCCESS	The operation was successful.
EFI_INVALID_PARAMETER	Guid was NULL.
EFI_INVALID_PARAMETER	GuidName was NULL.
EFI_NOT_FOUND	Guid is not assigned a name.

Definition at line 686 of file Shell.h.

◆ EFI_SHELL_GET_HELP_TEXT

typedef EFI_STATUS(EFIAPI * EFI_SHELL_GET_HELP_TEXT) (IN CONST CHAR16 *Command, IN CONST CHAR16 *Sections OPTIONAL, OUT CHAR16 **HelpText)

Return help information about a specific command.

This function returns the help information for the specified command. The help text can be internal to the shell or can be from a UEFI Shell manual page.

If Sections is specified, then each section name listed will be compared in a casesensitive manner, to the section names described in Appendix B. If the section exists, it will be appended to the returned help text. If the section does not exist, no information will be returned. If Sections is NULL, then all help text information available will be returned.

Parameters

[in]	Command	Points to the NULL-terminated UEFI Shell command name.
[in]	Sections	Points to the NULL-terminated comma-delimited section names to return. If NULL, then all sections will be returned.
[out]	HelpText	On return, points to a callee-allocated buffer containing all specified help text.

Return values

EFI_SUCCESS	The help text was returned.
EFI_OUT_OF_RESOURCES	The necessary buffer could not be allocated to hold the returned help text.
EFI_INVALID_PARAMETER	HelpText is NULL.
EFI_NOT_FOUND	There is no help text available for Command.

Definition at line 718 of file Shell.h.

◆ EFI_SHELL_GET_MAP_FROM_DEVICE_PATH

typedef CONST CHAR16 *(EFIAPI * EFI_SHELL_GET_MAP_FROM_DEVICE_PATH) (IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath)

Gets the mapping(s) that most closely matches the device path.

This function gets the mapping which corresponds to the device path *DevicePath. If there is no exact match, then the mapping which most closely matches *DevicePath is returned, and *DevicePath is updated to point to the remaining portion of the device path. If there is an exact match, the mapping is returned and *DevicePath points to the end-of-device-path node.

If there are multiple map names they will be semi-colon seperated in the NULL-terminated string.

Parameters

[in,out] DevicePath On entry, points to a device path pointer. On exit, updates the pointer to point to the portion of the device path after the mapping.

Return values

NULL	No mapping was found.
!=NULL	Pointer to NULL-terminated mapping. The buffer is callee allocated and should be freed by the caller.

Definition at line 746 of file Shell.h.

◆ EFI_SHELL_GET_PAGE_BREAK

typedef BOOLEAN(EFIAPI * EFI_SHELL_GET_PAGE_BREAK) (VOID)

Gets the enable status of the page break output mode.

User can use this function to determine current page break mode.

Return values

TRUE	The page break output mode is enabled.
FALSE	The page break output mode is disabled.

Definition at line 760 of file Shell.h.

◆ EFI_SHELL_IS_ROOT_SHELL

typedef BOOLEAN(EFIAPI * EFI_SHELL_IS_ROOT_SHELL) (VOID)

Judges whether the active shell is the root shell.

This function makes the user to know that whether the active Shell is the root shell.

Return values

TRUE	The active Shell is the root Shell.
FALSE	The active Shell is NOT the root Shell.

Definition at line 774 of file Shell.h.

◆ EFI_SHELL_OPEN_FILE_BY_NAME

typedef EFI_STATUS(EFIAPI * EFI_SHELL_OPEN_FILE_BY_NAME) (IN CONST CHAR16 *FileName, OUT SHELL_FILE_HANDLE *FileHandle, IN UINT64 OpenMode)

Opens a file or a directory by file name.

This function opens the specified file in the specified OpenMode and returns a file handle. If the file name begins with '>v', then the file handle which is returned refers to the shell environment variable with the specified name. If the shell environment variable exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER is returned.

If the file name is '>i', then the file handle which is returned refers to the standard input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER is returned.

If the file name is '>o', then the file handle which is returned refers to the standard output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is returned.

If the file name is '>e', then the file handle which is returned refers to the standard error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is returned.

If the file name is 'NUL', then the file handle that is returned refers to the standard NUL file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is returned.

If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the FileHandle is NULL.

Parameters

[in]	FileName	Points to the NULL-terminated UCS-2 encoded file name.
[out]	FileHandle	On return, points to the file handle.
[in]	OpenMode	File open mode. Either EFI_FILE_MODE_READ or EFI_FILE_MODE_WRITE from section 12.4 of the UEFI Specification.

Return values

EFI_SUCCESS	The file was opened. FileHandle has the opened file's handle.
EFI_INVALID_PARAMETER	One of the parameters has an invalid value. FileHandle is NULL.
EFI_UNSUPPORTED	Could not open the file path. FileHandle is NULL.
EFI_NOT_FOUND	The specified file could not be found on the device or the file system could not be found on the device. FileHandle is NULL.
EFI_NO_MEDIA	The device has no medium. FileHandle is NULL.
EFI_MEDIA_CHANGED	The device has a different medium in it or the medium is no longer supported. FileHandle is NULL.
EFI_DEVICE_ERROR	The device reported an error or can't get the file path according the FileName. FileHandle is NULL.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted. FileHandle is NULL.
EFI_WRITE_PROTECTED	An attempt was made to create a file, or open a file for write when the media is write-protected. FileHandle is NULL.
EFI_ACCESS_DENIED	The service denied access to the file. FileHandle is NULL.
EFI_OUT_OF_RESOURCES	Not enough resources were available to open the file. FileHandle is NULL.
EFI_VOLUME_FULL	The volume is full. FileHandle is NULL.

Definition at line 832 of file Shell.h.

◆ EFI_SHELL_OPEN_FILE_LIST

typedef EFI_STATUS(EFIAPI * EFI_SHELL_OPEN_FILE_LIST) (IN CHAR16 *Path, IN UINT64 OpenMode, IN OUT EFI_SHELL_FILE_INFO **FileList)

Opens the files that match the path specified.

This function opens all of the files specified by Path. Wildcards are processed according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.

Parameters

[in]	Path	A pointer to the path string.
[in]	OpenMode	Specifies the mode used to open each file, EFI_FILE_MODE_READ or EFI_FILE_MODE_WRITE.
[in,out]	FileList	Points to the start of a list of files opened.

Return values

EFI_SUCCESS Create the file list successfully.

Returns: Can't create the file list.

Definition at line 855 of file Shell.h.

◆ EFI_SHELL_OPEN_ROOT

typedef EFI_STATUS(EFIAPI * EFI_SHELL_OPEN_ROOT) (IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, OUT SHELL_FILE_HANDLE *FileHandle)

Opens the root directory of a device.

This function opens the root directory of a device and returns a file handle to it.

Parameters

[in]	DevicePath	Points to the device path corresponding to the device where the EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
[out]	FileHandle	On exit, points to the file handle corresponding to the root directory on the device.

Return values

EFI_SUCCESS	Root opened successfully.
EFI_NOT_FOUND	EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory could not be opened.
EFI_VOLUME_CORRUPTED	The data structures in the volume were corrupted.
EFI_DEVICE_ERROR	The device had an error.

Definition at line 879 of file Shell.h.

◆ EFI_SHELL_OPEN_ROOT_BY_HANDLE

typedef EFI_STATUS(EFIAPI * EFI_SHELL_OPEN_ROOT_BY_HANDLE) (IN EFI_HANDLE DeviceHandle, OUT SHELL_FILE_HANDLE *FileHandle)

Opens the root directory of a device on a handle.

This function opens the root directory of a device and returns a file handle to it.

Parameters

[in]	DeviceHandle	The handle of the device that contains the volume.
[out]	FileHandle	On exit, points to the file handle corresponding to the root directory on the device.

Return values

EFI_SUCCESS	Root opened successfully.
EFI_NOT_FOUND	EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory could not be opened.
EFI_VOLUME_CORRUPTED	The data structures in the volume were corrupted.
EFI_DEVICE_ERROR	The device had an error.

Definition at line 901 of file Shell.h.

◆ EFI_SHELL_READ_FILE

typedef EFI_STATUS(EFIAPI * EFI_SHELL_READ_FILE) (IN SHELL_FILE_HANDLE FileHandle, IN OUT UINTN *ReadSize, IN OUT VOID *Buffer)

Reads data from the file.

If FileHandle is not a directory, the function reads the requested number of bytes from the file at the file's current position and returns them in Buffer. If the read goes beyond the end of the file, the read length is truncated to the end of the file. The file's current position is increased by the number of bytes returned. If FileHandle is a directory, then an error is returned.

Parameters

[in]	FileHandle	The opened file handle for read.
[in]	ReadSize	On input, the size of Buffer, in bytes. On output, the amount of data read.
[in,out]	Buffer	The buffer in which data is read.

Return values

EFI_SUCCESS	Data was read.
EFI_NO_MEDIA	The device has no media.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_BUFFER_TO_SMALL	Buffer is too small. ReadSize contains required size.

Definition at line 927 of file Shell.h.

◆ EFI_SHELL_REGISTER_GUID_NAME

typedef EFI_STATUS(EFIAPI * EFI_SHELL_REGISTER_GUID_NAME) (IN CONST EFI_GUID *Guid, IN CONST CHAR16 *GuidName)

Register a GUID and a localized human readable name for it.

If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID names must be used whenever a shell command outputs GUID information.

This function is only available when the major and minor versions in the EfiShellProtocol are greater than or equal to 2 and 1, respectively.

Parameters

[in]	Guid	A pointer to the GUID being registered.
[in]	GuidName	A pointer to the localized name for the GUID being registered.

Return values

EFI_SUCCESS	The operation was successful.
EFI_INVALID_PARAMETER	Guid was NULL.
EFI_INVALID_PARAMETER	GuidName was NULL.
EFI_ACCESS_DENIED	Guid already is assigned a name.

Definition at line 952 of file Shell.h.

◆ EFI_SHELL_REMOVE_DUP_IN_FILE_LIST

typedef EFI_STATUS(EFIAPI * EFI_SHELL_REMOVE_DUP_IN_FILE_LIST) (IN EFI_SHELL_FILE_INFO **FileList)

Deletes the duplicate file names files in the given file list.

Parameters

[in] FileList A pointer to the first entry in the file list.

Return values

EFI_SUCCESS Always success.

Definition at line 966 of file Shell.h.

◆ EFI_SHELL_SET_ALIAS

typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_ALIAS) (IN CONST CHAR16 *Command, IN CONST CHAR16 *Alias, IN BOOLEAN Replace, IN BOOLEAN Volatile)

Changes a shell command alias.

This function creates an alias for a shell command.

Parameters

[in]	Command	Points to the NULL-terminated shell command or existing alias.
[in]	Alias	Points to the NULL-terminated alias for the shell command. If this is NULL, and Command refers to an alias, that alias will be deleted.
[in]	Replace	If TRUE and the alias already exists, then the existing alias will be replaced. If FALSE and the alias already exists, then the existing alias is unchanged and EFI_ACCESS_DENIED is returned.
[in]	Volatile	if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the Alias being set will be stored in a non-volatile fashion.

Return values

EFI_SUCCESS	Alias created or deleted successfully.
EFI_ACCESS_DENIED	The alias is a built-in alias or already existed and Replace was set to FALSE.

Definition at line 990 of file Shell.h.

◆ EFI_SHELL_SET_CUR_DIR

typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_CUR_DIR) (IN CONST CHAR16 *FileSystem OPTIONAL, IN CONST CHAR16 *Dir)

Changes the current directory on the specified device.

If the FileSystem is NULL, and the directory Dir does not contain a file system's mapped name, this function changes the current working directory. If FileSystem is NULL and the directory Dir contains a mapped name, then the current file system and the current directory on that file system are changed.

If FileSystem is not NULL, and Dir is NULL, then this changes the current working file system.

If FileSystem is not NULL and Dir is not NULL, then this function changes the current directory on the specified file system.

If the current working directory or the current working file system is changed then the cwd% environment variable will be updated.

Parameters

[in]	FileSystem	A pointer to the file system's mapped name. If NULL, then the current working directory is changed.
[in]	Dir	Points to the NULL-terminated directory on the device specified by FileSystem.

Return values

NULL	Current directory does not exist.

Returns: The current directory.

Definition at line 1047 of file Shell.h.

◆ EFI_SHELL_SET_ENV

typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_ENV) (IN CONST CHAR16 *Name, IN CONST CHAR16 *Value, IN BOOLEAN Volatile)

Sets the environment variable.

This function changes the current value of the specified environment variable. If the environment variable exists and the Value is an empty string, then the environment variable is deleted. If the environment variable exists and the Value is not an empty string, then the value of the environment variable is changed. If the environment variable does not exist and the Value is an empty string, there is no action. If the environment variable does not exist and the Value is a non-empty string, then the environment variable is created and assigned the specified value.

For a description of volatile and non-volatile environment variables, see UEFI Shell 2.0 specification section 3.6.1.

Parameters

[in]	Name	Points to the NULL-terminated environment variable name.
[in]	Value	Points to the NULL-terminated environment variable value. If the value is an empty string then the environment variable is deleted.
[in]	Volatile	Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).

Return values

EFI_SUCCESS The environment variable was successfully updated.

Definition at line 1075 of file Shell.h.

◆ EFI_SHELL_SET_FILE_INFO

typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_FILE_INFO) (IN SHELL_FILE_HANDLE FileHandle, IN CONST EFI_FILE_INFO *FileInfo)

Sets the file information to an opened file handle.

This function changes file information. All file information in the EFI_FILE_INFO struct will be updated to the passed in data.

Parameters

[in]	FileHandle	A file handle.
[in]	FileInfo	Points to new file information.

Return values

EFI_SUCCESS	The information was set.
EFI_NO_MEDIA	The device has no medium.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	The file or medium is write-protected.
EFI_ACCESS_DENIED	The file was opened read-only.
EFI_VOLUME_FULL	The volume is full.
EFI_BAD_BUFFER_SIZE	BufferSize is smaller than the size of EFI_FILE_INFO.

Definition at line 1101 of file Shell.h.

◆ EFI_SHELL_SET_FILE_POSITION

typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_FILE_POSITION) (IN SHELL_FILE_HANDLE FileHandle, IN UINT64 Position)

Sets a file's current position.

This function sets the current file position for the handle to the position supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only absolute positioning is supported, and seeking past the end of the file is allowed (a subsequent write would grow the file). Seeking to position 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.

Parameters

[in]	FileHandle	The file handle on which requested position will be set.
[in]	Position	Byte position from the start of the file.

Return values

EFI_SUCCESS	Data was written.
EFI_UNSUPPORTED	The seek request for nonzero is not valid on open directories.

Definition at line 1123 of file Shell.h.

◆ EFI_SHELL_SET_MAP

typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_MAP) (IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST CHAR16 *Mapping)

This function creates a mapping for a device path.

Parameters

[in]	DevicePath	Points to the device path. If this is NULL and Mapping points to a valid mapping, then the mapping will be deleted.
[in]	Mapping	Points to the NULL-terminated mapping for the device path.

Return values

EFI_SUCCESS	Mapping created or deleted successfully.
EFI_NO_MAPPING	There is no handle that corresponds exactly to DevicePath. See the boot service function LocateDevicePath().
EFI_ACCESS_DENIED	The mapping is a built-in alias.

Definition at line 1142 of file Shell.h.

◆ EFI_SHELL_WRITE_FILE

typedef EFI_STATUS(EFIAPI * EFI_SHELL_WRITE_FILE) (IN SHELL_FILE_HANDLE FileHandle, IN OUT UINTN *BufferSize, IN VOID *Buffer)

Writes data to the file.

This function writes the specified number of bytes to the file at the current file position. The current file position is advanced the actual number of bytes written, which is returned in BufferSize. Partial writes only occur when there has been a data error during the write attempt (such as "volume space full"). The file automatically grows to hold the data, if required.

Direct writes to opened directories are not supported.

Parameters

[in]	FileHandle	The opened file handle for writing.
[in,out]	BufferSize	On input, size of Buffer.
[in]	Buffer	The buffer in which data to write.

Return values

EFI_SUCCESS	Data was written.
EFI_UNSUPPORTED	Writes to open directory are not supported.
EFI_NO_MEDIA	The device has no media.
EFI_DEVICE_ERROR	The device reported an error.
EFI_VOLUME_CORRUPTED	The file system structures are corrupted.
EFI_WRITE_PROTECTED	The device is write-protected.
EFI_ACCESS_DENIED	The file was open for read only.
EFI_VOLUME_FULL	The volume is full.

Definition at line 1173 of file Shell.h.

◆ SHELL_FILE_HANDLE

typedef VOID* SHELL_FILE_HANDLE

Definition at line 19 of file Shell.h.

Enumeration Type Documentation

◆ SHELL_STATUS

enum SHELL_STATUS

Enumerator
SHELL_SUCCESS	The operation completed successfully.
SHELL_LOAD_ERROR	The image failed to load.
SHELL_INVALID_PARAMETER	The parameter was incorrect.
SHELL_UNSUPPORTED	The operation is not supported.
SHELL_BAD_BUFFER_SIZE	The buffer was not the proper size for the request.
SHELL_BUFFER_TOO_SMALL	The buffer was not large enough to hold the requested data. The required buffer size is returned in the appropriate parameter when this error occurs.
SHELL_NOT_READY	There is no data pending upon return.
SHELL_DEVICE_ERROR	The physical device reported an error while attempting the operation.
SHELL_WRITE_PROTECTED	The device cannot be written to.
SHELL_OUT_OF_RESOURCES	The resource has run out.
SHELL_VOLUME_CORRUPTED	An inconsistency was detected on the file system causing the operation to fail.
SHELL_VOLUME_FULL	There is no more space on the file system.
SHELL_NO_MEDIA	The device does not contain any medium to perform the operation.
SHELL_MEDIA_CHANGED	The medium in the device has changed since the last access.
SHELL_NOT_FOUND	The item was not found.
SHELL_ACCESS_DENIED	Access was denied.
SHELL_TIMEOUT	A timeout time expired.
SHELL_NOT_STARTED	The protocol has not been started.
SHELL_ALREADY_STARTED	The protocol has already been started.
SHELL_ABORTED	The operation was aborted.
SHELL_INCOMPATIBLE_VERSION	A function encountered an internal version that was incompatible with a version requested by the caller.
SHELL_SECURITY_VIOLATION	The function was not performed due to a security violation.
SHELL_NOT_EQUAL	The function was performed and resulted in an unequal comparison..

Definition at line 21 of file Shell.h.

◆ ShellVersion

enum ShellVersion

Definition at line 1256 of file Shell.h.

Data Structures

Macros

Typedefs

Enumerations

Variables

Detailed Description

Macro Definition Documentation

◆ EFI_DEVICE_NAME_USE_COMPONENT_NAME

◆ EFI_DEVICE_NAME_USE_DEVICE_PATH

◆ EFI_SHELL_PROTOCOL_GUID

Typedef Documentation

◆ EFI_SHELL_BATCH_IS_ACTIVE

◆ EFI_SHELL_CLOSE_FILE

◆ EFI_SHELL_CREATE_FILE

◆ EFI_SHELL_DELETE_FILE

◆ EFI_SHELL_DELETE_FILE_BY_NAME

◆ EFI_SHELL_DEVICE_NAME_FLAGS

◆ EFI_SHELL_DISABLE_PAGE_BREAK

◆ EFI_SHELL_ENABLE_PAGE_BREAK

◆ EFI_SHELL_EXECUTE

◆ EFI_SHELL_FIND_FILES

◆ EFI_SHELL_FIND_FILES_IN_DIR

◆ EFI_SHELL_FLUSH_FILE

◆ EFI_SHELL_FREE_FILE_LIST

◆ EFI_SHELL_GET_ALIAS

◆ EFI_SHELL_GET_CUR_DIR

◆ EFI_SHELL_GET_DEVICE_NAME

◆ EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH

◆ EFI_SHELL_GET_DEVICE_PATH_FROM_MAP

◆ EFI_SHELL_GET_ENV

◆ EFI_SHELL_GET_ENV_EX

◆ EFI_SHELL_GET_FILE_INFO

◆ EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH

◆ EFI_SHELL_GET_FILE_POSITION

◆ EFI_SHELL_GET_FILE_SIZE

◆ EFI_SHELL_GET_GUID_FROM_NAME

◆ EFI_SHELL_GET_GUID_NAME

◆ EFI_SHELL_GET_HELP_TEXT

◆ EFI_SHELL_GET_MAP_FROM_DEVICE_PATH

◆ EFI_SHELL_GET_PAGE_BREAK

◆ EFI_SHELL_IS_ROOT_SHELL

◆ EFI_SHELL_OPEN_FILE_BY_NAME

◆ EFI_SHELL_OPEN_FILE_LIST

◆ EFI_SHELL_OPEN_ROOT

◆ EFI_SHELL_OPEN_ROOT_BY_HANDLE

◆ EFI_SHELL_READ_FILE

◆ EFI_SHELL_REGISTER_GUID_NAME

◆ EFI_SHELL_REMOVE_DUP_IN_FILE_LIST

◆ EFI_SHELL_SET_ALIAS

◆ EFI_SHELL_SET_CUR_DIR

◆ EFI_SHELL_SET_ENV

◆ EFI_SHELL_SET_FILE_INFO

◆ EFI_SHELL_SET_FILE_POSITION

◆ EFI_SHELL_SET_MAP

◆ EFI_SHELL_WRITE_FILE

◆ SHELL_FILE_HANDLE

Enumeration Type Documentation

◆ SHELL_STATUS

◆ ShellVersion