EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Data Structures | Defines | Functions | Variables

ShellPkg/Library/UefiShellLib/UefiShellLib.c File Reference

#include "UefiShellLib.h"
#include <ShellBase.h>
#include <Library/SortLib.h>

Go to the source code of this file.

Data Structures

struct  EFI_SHELL_FILE_INFO_NO_CONST
struct  SHELL_PARAM_PACKAGE

Defines

#define FIND_XXXXX_FILE_BUFFER_SIZE   (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)

Functions

BOOLEAN EFIAPI ShellIsHexaDecimalDigitCharacter (IN CHAR16 Char)
BOOLEAN EFIAPI ShellIsDecimalDigitCharacter (IN CHAR16 Char)
EFI_STATUS EFIAPI ShellFindSE2 (IN EFI_HANDLE ImageHandle)
EFI_STATUS EFIAPI ShellLibConstructorWorker (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI ShellLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI ShellLibDestructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI ShellInitialize ()
EFI_FILE_INFO *EFIAPI ShellGetFileInfo (IN SHELL_FILE_HANDLE FileHandle)
EFI_STATUS EFIAPI ShellSetFileInfo (IN SHELL_FILE_HANDLE FileHandle, IN EFI_FILE_INFO *FileInfo)
EFI_STATUS EFIAPI ShellOpenFileByDevicePath (IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath, OUT EFI_HANDLE *DeviceHandle, OUT SHELL_FILE_HANDLE *FileHandle, IN UINT64 OpenMode, IN UINT64 Attributes)
EFI_STATUS EFIAPI ShellOpenFileByName (IN CONST CHAR16 *FileName, OUT SHELL_FILE_HANDLE *FileHandle, IN UINT64 OpenMode, IN UINT64 Attributes)
EFI_STATUS EFIAPI ShellCreateDirectory (IN CONST CHAR16 *DirectoryName, OUT SHELL_FILE_HANDLE *FileHandle)
EFI_STATUS EFIAPI ShellReadFile (IN SHELL_FILE_HANDLE FileHandle, IN OUT UINTN *BufferSize, OUT VOID *Buffer)
EFI_STATUS EFIAPI ShellWriteFile (IN SHELL_FILE_HANDLE FileHandle, IN OUT UINTN *BufferSize, IN VOID *Buffer)
EFI_STATUS EFIAPI ShellCloseFile (IN SHELL_FILE_HANDLE *FileHandle)
EFI_STATUS EFIAPI ShellDeleteFile (IN SHELL_FILE_HANDLE *FileHandle)
EFI_STATUS EFIAPI ShellSetFilePosition (IN SHELL_FILE_HANDLE FileHandle, IN UINT64 Position)
EFI_STATUS EFIAPI ShellGetFilePosition (IN SHELL_FILE_HANDLE FileHandle, OUT UINT64 *Position)
EFI_STATUS EFIAPI ShellFlushFile (IN SHELL_FILE_HANDLE FileHandle)
EFI_STATUS EFIAPI ShellFindFirstFile (IN SHELL_FILE_HANDLE DirHandle, OUT EFI_FILE_INFO **Buffer)
EFI_STATUS EFIAPI ShellFindNextFile (IN SHELL_FILE_HANDLE DirHandle, OUT EFI_FILE_INFO *Buffer, OUT BOOLEAN *NoFile)
EFI_STATUS EFIAPI ShellGetFileSize (IN SHELL_FILE_HANDLE FileHandle, OUT UINT64 *Size)
BOOLEAN EFIAPI ShellGetExecutionBreakFlag (VOID)
CONST CHAR16 *EFIAPI ShellGetEnvironmentVariable (IN CONST CHAR16 *EnvKey)
EFI_STATUS EFIAPI ShellSetEnvironmentVariable (IN CONST CHAR16 *EnvKey, IN CONST CHAR16 *EnvVal, IN BOOLEAN Volatile)
EFI_STATUS EFIAPI ShellExecute (IN EFI_HANDLE *ParentHandle, IN CHAR16 *CommandLine OPTIONAL, IN BOOLEAN Output OPTIONAL, IN CHAR16 **EnvironmentVariables OPTIONAL, OUT EFI_STATUS *Status OPTIONAL)
CONST CHAR16 *EFIAPI ShellGetCurrentDir (IN CHAR16 *CONST DeviceName OPTIONAL)
VOID EFIAPI ShellSetPageBreakMode (IN BOOLEAN CurrentState)
LIST_ENTRY *EFIAPI InternalShellConvertFileListType (IN LIST_ENTRY *FileList, IN OUT LIST_ENTRY *ListHead)
EFI_STATUS EFIAPI ShellOpenFileMetaArg (IN CHAR16 *Arg, IN UINT64 OpenMode, IN OUT EFI_SHELL_FILE_INFO **ListHead)
EFI_STATUS EFIAPI ShellCloseFileMetaArg (IN OUT EFI_SHELL_FILE_INFO **ListHead)
CHAR16 *EFIAPI ShellFindFilePath (IN CONST CHAR16 *FileName)
CHAR16 *EFIAPI ShellFindFilePathEx (IN CONST CHAR16 *FileName, IN CONST CHAR16 *FileExtension)
BOOLEAN EFIAPI InternalIsOnCheckList (IN CONST CHAR16 *Name, IN CONST SHELL_PARAM_ITEM *CheckList, OUT SHELL_PARAM_TYPE *Type)
BOOLEAN EFIAPI InternalIsFlag (IN CONST CHAR16 *Name, IN BOOLEAN AlwaysAllowNumbers)
EFI_STATUS EFIAPI InternalCommandLineParse (IN CONST SHELL_PARAM_ITEM *CheckList, OUT LIST_ENTRY **CheckPackage, OUT CHAR16 **ProblemParam OPTIONAL, IN BOOLEAN AutoPageBreak, IN CONST CHAR16 **Argv, IN UINTN Argc, IN BOOLEAN AlwaysAllowNumbers)
EFI_STATUS EFIAPI ShellCommandLineParseEx (IN CONST SHELL_PARAM_ITEM *CheckList, OUT LIST_ENTRY **CheckPackage, OUT CHAR16 **ProblemParam OPTIONAL, IN BOOLEAN AutoPageBreak, IN BOOLEAN AlwaysAllowNumbers)
VOID EFIAPI ShellCommandLineFreeVarList (IN LIST_ENTRY *CheckPackage)
BOOLEAN EFIAPI ShellCommandLineGetFlag (IN CONST LIST_ENTRY *CONST CheckPackage, IN CONST CHAR16 *CONST KeyString)
CONST CHAR16 *EFIAPI ShellCommandLineGetValue (IN CONST LIST_ENTRY *CheckPackage, IN CHAR16 *KeyString)
CONST CHAR16 *EFIAPI ShellCommandLineGetRawValue (IN CONST LIST_ENTRY *CONST CheckPackage, IN UINTN Position)
UINTN EFIAPI ShellCommandLineGetCount (IN CONST LIST_ENTRY *CheckPackage)
EFI_STATUS EFIAPI ShellCommandLineCheckDuplicate (IN CONST LIST_ENTRY *CheckPackage, OUT CHAR16 **Param)
EFI_STATUS EFIAPI ShellCopySearchAndReplace (IN CHAR16 CONST *SourceString, IN OUT CHAR16 *NewString, IN UINTN NewSize, IN CONST CHAR16 *FindTarget, IN CONST CHAR16 *ReplaceWith, IN CONST BOOLEAN SkipPreCarrot, IN CONST BOOLEAN ParameterReplacing)
EFI_STATUS EFIAPI InternalPrintTo (IN CONST CHAR16 *String)
EFI_STATUS EFIAPI InternalShellPrintWorker (IN INT32 Col OPTIONAL, IN INT32 Row OPTIONAL, IN CONST CHAR16 *Format, IN VA_LIST Marker)
EFI_STATUS EFIAPI ShellPrintEx (IN INT32 Col OPTIONAL, IN INT32 Row OPTIONAL, IN CONST CHAR16 *Format,...)
EFI_STATUS EFIAPI ShellPrintHiiEx (IN INT32 Col OPTIONAL, IN INT32 Row OPTIONAL, IN CONST CHAR8 *Language OPTIONAL, IN CONST EFI_STRING_ID HiiFormatStringId, IN CONST EFI_HANDLE HiiFormatHandle,...)
EFI_STATUS EFIAPI ShellIsDirectory (IN CONST CHAR16 *DirName)
EFI_STATUS EFIAPI ShellIsFile (IN CONST CHAR16 *Name)
EFI_STATUS EFIAPI ShellIsFileInPath (IN CONST CHAR16 *Name)
UINTN EFIAPI ShellStrToUintn (IN CONST CHAR16 *String)
CHAR16 *EFIAPI StrnCatGrow (IN OUT CHAR16 **Destination, IN OUT UINTN *CurrentSize, IN CONST CHAR16 *Source, IN UINTN Count)
EFI_STATUS EFIAPI ShellPromptForResponse (IN SHELL_PROMPT_REQUEST_TYPE Type, IN CHAR16 *Prompt OPTIONAL, IN OUT VOID **Response OPTIONAL)
EFI_STATUS EFIAPI ShellPromptForResponseHii (IN SHELL_PROMPT_REQUEST_TYPE Type, IN CONST EFI_STRING_ID HiiFormatStringId, IN CONST EFI_HANDLE HiiFormatHandle, IN OUT VOID **Response)
BOOLEAN EFIAPI InternalShellIsHexOrDecimalNumber (IN CONST CHAR16 *String, IN CONST BOOLEAN ForceHex, IN CONST BOOLEAN StopAtSpace)
EFI_STATUS EFIAPI ShellFileExists (IN CONST CHAR16 *Name)
CHAR16 EFIAPI InternalShellCharToUpper (IN CHAR16 Char)
UINTN EFIAPI InternalShellHexCharToUintn (IN CHAR16 Char)
EFI_STATUS EFIAPI InternalShellStrHexToUint64 (IN CONST CHAR16 *String, OUT UINT64 *Value, IN CONST BOOLEAN StopAtSpace)
EFI_STATUS EFIAPI InternalShellStrDecimalToUint64 (IN CONST CHAR16 *String, OUT UINT64 *Value, IN CONST BOOLEAN StopAtSpace)
EFI_STATUS EFIAPI ShellConvertStringToUint64 (IN CONST CHAR16 *String, OUT UINT64 *Value, IN CONST BOOLEAN ForceHex, IN CONST BOOLEAN StopAtSpace)
BOOLEAN EFIAPI ShellIsHexOrDecimalNumber (IN CONST CHAR16 *String, IN CONST BOOLEAN ForceHex, IN CONST BOOLEAN StopAtSpace)
CHAR16 *EFIAPI ShellFileHandleReturnLine (IN SHELL_FILE_HANDLE Handle, IN OUT BOOLEAN *Ascii)
EFI_STATUS EFIAPI ShellFileHandleReadLine (IN SHELL_FILE_HANDLE Handle, IN OUT CHAR16 *Buffer, IN OUT UINTN *Size, IN BOOLEAN Truncate, IN OUT BOOLEAN *Ascii)

Variables

SHELL_PARAM_ITEM EmptyParamList []
 Helper structure for no parameters (besides -? and -b)
SHELL_PARAM_ITEM SfoParamList []
 Helper structure for -sfo only (besides -? and -b)
EFI_SHELL_ENVIRONMENT2mEfiShellEnvironment2
EFI_SHELL_INTERFACEmEfiShellInterface
EFI_SHELL_PROTOCOLgEfiShellProtocol
EFI_SHELL_PARAMETERS_PROTOCOLgEfiShellParametersProtocol
EFI_HANDLE mEfiShellEnvironment2Handle
FILE_HANDLE_FUNCTION_MAP FileFunctionMap

Detailed Description

Provides interface to shell functionality for shell commands and applications.

Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file UefiShellLib.c.


Define Documentation

#define FIND_XXXXX_FILE_BUFFER_SIZE   (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)

Definition at line 19 of file UefiShellLib.c.


Function Documentation

EFI_STATUS EFIAPI InternalCommandLineParse ( IN CONST SHELL_PARAM_ITEM CheckList,
OUT LIST_ENTRY **  CheckPackage,
OUT CHAR16 **ProblemParam  OPTIONAL,
IN BOOLEAN  AutoPageBreak,
IN CONST CHAR16 **  Argv,
IN UINTN  Argc,
IN BOOLEAN  AlwaysAllowNumbers 
)

Checks the command line arguments passed against the list of valid ones.

If no initialization is required, then return RETURN_SUCCESS.

Parameters:
[in]CheckListpointer to list of parameters to check
[out]CheckPackagepointer to pointer to list checked values
[out]ProblemParamoptional pointer to pointer to unicode string for the paramater that caused failure. If used then the caller is responsible for freeing the memory.
[in]AutoPageBreakwill automatically set PageBreakEnabled for "b" parameter
[in]Argvpointer to array of parameters
[in]ArgcCount of parameters in Argv
[in]AlwaysAllowNumbersTRUE to allow numbers always, FALSE otherwise.
Return values:
EFI_SUCCESSThe operation completed sucessfully.
EFI_OUT_OF_RESOURCESA memory allocation failed
EFI_INVALID_PARAMETERA parameter was invalid
EFI_VOLUME_CORRUPTEDthe command line was corrupt. an argument was duplicated. the duplicated command line argument was returned in ProblemParam if provided.
EFI_NOT_FOUNDa argument required a value that was missing. the invalid command line argument was returned in ProblemParam if provided.

Definition at line 1903 of file UefiShellLib.c.

BOOLEAN EFIAPI InternalIsFlag ( IN CONST CHAR16 Name,
IN BOOLEAN  AlwaysAllowNumbers 
)

Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'

Parameters:
[in]Namepointer to Name of parameter found
[in]AlwaysAllowNumbersTRUE to allow numbers, FALSE to not.
Return values:
TRUEthe Parameter is a flag.
FALSEthe Parameter not a flag.

Definition at line 1847 of file UefiShellLib.c.

BOOLEAN EFIAPI InternalIsOnCheckList ( IN CONST CHAR16 Name,
IN CONST SHELL_PARAM_ITEM CheckList,
OUT SHELL_PARAM_TYPE Type 
)

Checks the list of valid arguments and returns TRUE if the item was found. If the return value is TRUE then the type parameter is set also.

if CheckList is NULL then ASSERT(); if Name is NULL then ASSERT(); if Type is NULL then ASSERT();

Parameters:
Namepointer to Name of parameter found
CheckListList to check against
Typepointer to type of parameter if it was found
Return values:
TRUEthe Parameter was found. Type is valid.
FALSEthe Parameter was not found. Type is not valid.

Definition at line 1779 of file UefiShellLib.c.

EFI_STATUS EFIAPI InternalPrintTo ( IN CONST CHAR16 String)

Internal worker function to output a string.

This function will output a string to the correct StdOut.

Parameters:
[in]StringThe string to print out.
Return values:
EFI_SUCCESSThe operation was sucessful.
!EFI_SUCCESSThe operation failed.

Definition at line 2577 of file UefiShellLib.c.

CHAR16 EFIAPI InternalShellCharToUpper ( IN CHAR16  Char)

Convert a Unicode character to upper case only if it maps to a valid small-case ASCII character.

This internal function only deal with Unicode character which maps to a valid small-case ASCII character, i.e. L'a' to L'z'. For other Unicode character, the input character is returned directly.

Parameters:
CharThe character to convert.
Return values:
LowerCharacterIf the Char is with range L'a' to L'z'.
UnchangedOtherwise.

Definition at line 3519 of file UefiShellLib.c.

LIST_ENTRY* EFIAPI InternalShellConvertFileListType ( IN LIST_ENTRY FileList,
IN OUT LIST_ENTRY ListHead 
)

Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.

if OldStyleFileList is NULL then ASSERT()

this function will convert a SHELL_FILE_ARG based list into a callee allocated EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via the ShellCloseFileMetaArg function.

Parameters:
[in]FileListthe EFI shell list type
[in,out]ListHeadthe list to add to
Return values:
theresultant head of the double linked new format list;

Definition at line 1330 of file UefiShellLib.c.

UINTN EFIAPI InternalShellHexCharToUintn ( IN CHAR16  Char)

Convert a Unicode character to numerical value.

This internal function only deal with Unicode character which maps to a valid hexadecimal ASII character, i.e. L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other Unicode character, the value returned does not make sense.

Parameters:
CharThe character to convert.
Returns:
The numerical value converted.

Definition at line 3545 of file UefiShellLib.c.

BOOLEAN EFIAPI InternalShellIsHexOrDecimalNumber ( IN CONST CHAR16 String,
IN CONST BOOLEAN  ForceHex,
IN CONST BOOLEAN  StopAtSpace 
)

Function to determin if an entire string is a valid number.

If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.

Parameters:
[in]StringThe string to evaluate.
[in]ForceHexTRUE - always assume hex.
[in]StopAtSpaceTRUE to halt upon finding a space, FALSE to keep going.
Return values:
TRUEIt is all numeric (dec/hex) characters.
FALSEThere is a non-numeric character.

Definition at line 3410 of file UefiShellLib.c.

EFI_STATUS EFIAPI InternalShellPrintWorker ( IN INT32 Col  OPTIONAL,
IN INT32 Row  OPTIONAL,
IN CONST CHAR16 Format,
IN VA_LIST  Marker 
)

Print at a specific location on the screen.

This function will move the cursor to a given screen location and print the specified string

If -1 is specified for either the Row or Col the current screen location for BOTH will be used.

if either Row or Col is out of range for the current console, then ASSERT if Format is NULL, then ASSERT

In addition to the standard -based flags as supported by UefiLib Print() this supports the following additional flags: N - Set output attribute to normal H - Set output attribute to highlight E - Set output attribute to error B - Set output attribute to blue color V - Set output attribute to green color

Note: The background color is controlled by the shell command cls.

Parameters:
[in]Colthe column to print at
[in]Rowthe row to print at
[in]Formatthe format string
[in]Markerthe marker for the variable argument list
Returns:
EFI_SUCCESS The operation was successful.
EFI_DEVICE_ERROR The console device reported an error.

Definition at line 2631 of file UefiShellLib.c.

EFI_STATUS EFIAPI InternalShellStrDecimalToUint64 ( IN CONST CHAR16 String,
OUT UINT64 Value,
IN CONST BOOLEAN  StopAtSpace 
)

Convert a Null-terminated Unicode decimal string to a value of type UINT64.

This function returns a value of type UINT64 by interpreting the contents of the Unicode string specified by String as a decimal number. The format of the input Unicode string String is:

[spaces] [decimal digits].

The valid decimal digit character is in the range [0-9]. The function will ignore the pad space, which includes spaces or tab characters, before [decimal digits]. The running zero in the beginning of [decimal digits] will be ignored. Then, the function stops at the first character that is a not a valid decimal character or a Null-terminator, whichever one comes first.

If String has only pad spaces, then 0 is returned. If String has no pad spaces or valid decimal digits, then 0 is returned.

Parameters:
[in]StringA pointer to a Null-terminated Unicode string.
[out]ValueUpon a successful return the value of the conversion.
[in]StopAtSpaceFALSE to skip spaces.
Return values:
EFI_SUCCESSThe conversion was successful.
EFI_INVALID_PARAMETERA parameter was NULL or invalid.
EFI_DEVICE_ERRORAn overflow occured.

Definition at line 3690 of file UefiShellLib.c.

EFI_STATUS EFIAPI InternalShellStrHexToUint64 ( IN CONST CHAR16 String,
OUT UINT64 Value,
IN CONST BOOLEAN  StopAtSpace 
)

Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.

This function returns a value of type UINTN by interpreting the contents of the Unicode string specified by String as a hexadecimal number. The format of the input Unicode string String is:

[spaces][zeros][x][hexadecimal digits].

The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F]. The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x" appears in the input string, it must be prefixed with at least one 0. The function will ignore the pad space, which includes spaces or tab characters, before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal digit. Then, the function stops at the first character that is a not a valid hexadecimal character or NULL, whichever one comes first.

If String has only pad spaces, then zero is returned. If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then zero is returned.

Parameters:
[in]StringA pointer to a Null-terminated Unicode string.
[out]ValueUpon a successful return the value of the conversion.
[in]StopAtSpaceFALSE to skip spaces.
Return values:
EFI_SUCCESSThe conversion was successful.
EFI_INVALID_PARAMETERA parameter was NULL or invalid.
EFI_DEVICE_ERRORAn overflow occured.

Definition at line 3588 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellCloseFile ( IN SHELL_FILE_HANDLE FileHandle)

Close an open 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:
FileHandlethe file handle to close.
Return values:
EFI_SUCCESSthe file handle was closed sucessfully.

Definition at line 829 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellCloseFileMetaArg ( IN OUT EFI_SHELL_FILE_INFO **  ListHead)

Free the linked list returned from ShellOpenFileMetaArg.

if ListHead is NULL then ASSERT().

Parameters:
ListHeadthe pointer to free.
Return values:
EFI_SUCCESSthe operation was sucessful.

Definition at line 1539 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellCommandLineCheckDuplicate ( IN CONST LIST_ENTRY CheckPackage,
OUT CHAR16 **  Param 
)

Determins if a parameter is duplicated.

If Param is not NULL then it will point to a callee allocated string buffer with the parameter value if a duplicate is found.

If CheckPackage is NULL, then ASSERT.

Parameters:
[in]CheckPackageThe package of parsed command line arguments.
[out]ParamUpon finding one, a pointer to the duplicated parameter.
Return values:
EFI_SUCCESSNo parameters were duplicated.
EFI_DEVICE_ERRORA duplicate was found.

Definition at line 2442 of file UefiShellLib.c.

VOID EFIAPI ShellCommandLineFreeVarList ( IN LIST_ENTRY CheckPackage)

Frees shell variable list that was returned from ShellCommandLineParse.

This function will free all the memory that was used for the CheckPackage list of postprocessed shell arguments.

this function has no return value.

if CheckPackage is NULL, then return

Parameters:
CheckPackagethe list to de-allocate

Definition at line 2168 of file UefiShellLib.c.

UINTN EFIAPI ShellCommandLineGetCount ( IN CONST LIST_ENTRY CheckPackage)

returns the number of command line value parameters that were parsed.

this will not include flags.

Parameters:
[in]CheckPackageThe package of parsed command line arguments.
Return values:
(UINTN)-1No parsing has ocurred
Returns:
other The number of value parameters found

Definition at line 2405 of file UefiShellLib.c.

BOOLEAN EFIAPI ShellCommandLineGetFlag ( IN CONST LIST_ENTRY *CONST  CheckPackage,
IN CONST CHAR16 *CONST  KeyString 
)

Checks for presence of a flag parameter

flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key

if CheckPackage is NULL then return FALSE. if KeyString is NULL then ASSERT()

Parameters:
CheckPackageThe package of parsed command line arguments
KeyStringthe Key of the command line argument to check for
Return values:
TRUEthe flag is on the command line
FALSEthe flag is not on the command line

Definition at line 2233 of file UefiShellLib.c.

CONST CHAR16* EFIAPI ShellCommandLineGetRawValue ( IN CONST LIST_ENTRY *CONST  CheckPackage,
IN UINTN  Position 
)

Returns raw value from command line argument.

Raw value parameters are in the form of "value" in a specific position in the list.

If CheckPackage is NULL, then return NULL.

Parameters:
[in]CheckPackageThe package of parsed command line arguments.
[in]PositionThe position of the value.
Return values:
NULLThe flag is not on the command line.
!=NULLThe pointer to unicode string of the value.

Definition at line 2362 of file UefiShellLib.c.

CONST CHAR16* EFIAPI ShellCommandLineGetValue ( IN CONST LIST_ENTRY CheckPackage,
IN CHAR16 KeyString 
)

Returns value from command line argument.

Value parameters are in the form of "-<Key> value" or "/<Key> value".

If CheckPackage is NULL, then return NULL.

Parameters:
[in]CheckPackageThe package of parsed command line arguments.
[in]KeyStringThe Key of the command line argument to check for.
Return values:
NULLThe flag is not on the command line.
!=NULLThe pointer to unicode string of the value.

Definition at line 2297 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellCommandLineParseEx ( IN CONST SHELL_PARAM_ITEM CheckList,
OUT LIST_ENTRY **  CheckPackage,
OUT CHAR16 **ProblemParam  OPTIONAL,
IN BOOLEAN  AutoPageBreak,
IN BOOLEAN  AlwaysAllowNumbers 
)

Checks the command line arguments passed against the list of valid ones. Optionally removes NULL values first.

If no initialization is required, then return RETURN_SUCCESS.

Parameters:
[in]CheckListThe pointer to list of parameters to check.
[out]CheckPackageThe package of checked values.
[out]ProblemParamOptional pointer to pointer to unicode string for the paramater that caused failure.
[in]AutoPageBreakWill automatically set PageBreakEnabled.
[in]AlwaysAllowNumbersWill never fail for number based flags.
Return values:
EFI_SUCCESSThe operation completed sucessfully.
EFI_OUT_OF_RESOURCESA memory allocation failed.
EFI_INVALID_PARAMETERA parameter was invalid.
EFI_VOLUME_CORRUPTEDThe command line was corrupt.
EFI_DEVICE_ERRORThe commands contained 2 opposing arguments. One of the command line arguments was returned in ProblemParam if provided.
EFI_NOT_FOUNDA argument required a value that was missing. The invalid command line argument was returned in ProblemParam if provided.

Definition at line 2114 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellConvertStringToUint64 ( IN CONST CHAR16 String,
OUT UINT64 Value,
IN CONST BOOLEAN  ForceHex,
IN CONST BOOLEAN  StopAtSpace 
)

Function to verify and convert a string to its numerical value.

If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.

Parameters:
[in]StringThe string to evaluate.
[out]ValueUpon a successful return the value of the conversion.
[in]ForceHexTRUE - always assume hex.
[in]StopAtSpaceFALSE to skip spaces.
Return values:
EFI_SUCCESSThe conversion was successful.
EFI_INVALID_PARAMETERString contained an invalid character.
EFI_NOT_FOUNDString was a number, but Value was NULL.

Definition at line 3766 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellCopySearchAndReplace ( IN CHAR16 CONST *  SourceString,
IN OUT CHAR16 NewString,
IN UINTN  NewSize,
IN CONST CHAR16 FindTarget,
IN CONST CHAR16 ReplaceWith,
IN CONST BOOLEAN  SkipPreCarrot,
IN CONST BOOLEAN  ParameterReplacing 
)

This is a find and replace function. Upon successful return the NewString is a copy of SourceString with each instance of FindTarget replaced with ReplaceWith.

If SourceString and NewString overlap the behavior is undefined.

If the string would grow bigger than NewSize it will halt and return error.

Parameters:
[in]SourceStringThe string with source buffer.
[in,out]NewStringThe string with resultant buffer.
[in]NewSizeThe size in bytes of NewString.
[in]FindTargetThe string to look for.
[in]ReplaceWithThe string to replace FindTarget with.
[in]SkipPreCarrotIf TRUE will skip a FindTarget that has a '^' immediately before it.
[in]ParameterReplacingIf TRUE will add "" around items with spaces.
Return values:
EFI_INVALID_PARAMETERSourceString was NULL.
EFI_INVALID_PARAMETERNewString was NULL.
EFI_INVALID_PARAMETERFindTarget was NULL.
EFI_INVALID_PARAMETERReplaceWith was NULL.
EFI_INVALID_PARAMETERFindTarget had length < 1.
EFI_INVALID_PARAMETERSourceString had length < 1.
EFI_BUFFER_TOO_SMALLNewSize was less than the minimum size to hold the new string (truncation occurred).
EFI_SUCCESSThe string was successfully copied with replacement.

Definition at line 2501 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellCreateDirectory ( IN CONST CHAR16 DirectoryName,
OUT SHELL_FILE_HANDLE FileHandle 
)

This function create a directory

If return is EFI_SUCCESS, the Filehandle is the opened directory's handle; otherwise, the Filehandle is NULL. If the directory already existed, this function opens the existing directory.

Parameters:
DirectoryNamepointer to directory name
FileHandlepointer to the file handle.
Return values:
EFI_SUCCESSThe information was set.
EFI_INVALID_PARAMETEROne of the parameters has an invalid value.
EFI_UNSUPPORTEDCould not open the file path.
EFI_NOT_FOUNDThe specified file could not be found on the device or the file system could not be found on the device.
EFI_NO_MEDIAThe device has no medium.
EFI_MEDIA_CHANGEDThe device has a different medium in it or the medium is no longer supported.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write protected.
EFI_ACCESS_DENIEDThe file was opened read only.
EFI_OUT_OF_RESOURCESNot enough resources were available to open the file.
EFI_VOLUME_FULLThe volume is full.
See also:
ShellOpenFileByName

Definition at line 718 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellDeleteFile ( IN SHELL_FILE_HANDLE FileHandle)

Delete a file and close the 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:
FileHandlethe file handle to delete
Return values:
EFI_SUCCESSthe file was closed sucessfully
EFI_WARN_DELETE_FAILUREthe handle was closed, but the file was not deleted
INVALID_PARAMETEROne of the parameters has an invalid value.

Definition at line 852 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellExecute ( IN EFI_HANDLE ParentHandle,
IN CHAR16 *CommandLine  OPTIONAL,
IN BOOLEAN Output  OPTIONAL,
IN CHAR16 **EnvironmentVariables  OPTIONAL,
OUT EFI_STATUS *Status  OPTIONAL 
)

Cause the shell to parse and execute a 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.

The EnvironmentVariables and Status parameters are ignored in a pre-UEFI Shell 2.0 environment. The values pointed to by the parameters will be unchanged by the ShellExecute() function. The Output parameter has no effect in a UEFI Shell 2.0 environment.

Parameters:
[in]ParentHandleThe parent image starting the operation.
[in]CommandLineThe pointer to a NULL terminated command line.
[in]OutputTrue to display debug output. False to hide it.
[in]EnvironmentVariablesOptional pointer to array of environment variables in the form "x=y". If NULL, the current set is used.
[out]StatusThe status of the run command line.
Return values:
EFI_SUCCESSThe operation completed sucessfully. Status contains the status code returned.
EFI_INVALID_PARAMETERA parameter contains an invalid value.
EFI_OUT_OF_RESOURCESOut of resources.
EFI_UNSUPPORTEDThe operation is not allowed.

Definition at line 1167 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellFileExists ( IN CONST CHAR16 Name)

Function to determine if a given filename exists.

Parameters:
[in]NamePath to test.
Return values:
EFI_SUCCESSThe Path represents a file.
EFI_NOT_FOUNDThe Path does not represent a file.
otherThe path failed to open.

Definition at line 3482 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellFileHandleReadLine ( IN SHELL_FILE_HANDLE  Handle,
IN OUT CHAR16 Buffer,
IN OUT UINTN Size,
IN BOOLEAN  Truncate,
IN OUT BOOLEAN Ascii 
)

Function to read a single line (up to but not including the
) from a SHELL_FILE_HANDLE.

If the position upon start is 0, then the Ascii Boolean will be set. This should be maintained and not changed for all operations with the same file.

Parameters:
[in]HandleSHELL_FILE_HANDLE to read from.
[in,out]BufferThe pointer to buffer to read into.
[in,out]SizeThe pointer to number of bytes in Buffer.
[in]TruncateIf the buffer is large enough, this has no effect. If the buffer is is too small and Truncate is TRUE, the line will be truncated. If the buffer is is too small and Truncate is FALSE, then no read will occur.
[in,out]AsciiBoolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE).
Return values:
EFI_SUCCESSThe operation was successful. The line is stored in Buffer.
EFI_INVALID_PARAMETERHandle was NULL.
EFI_INVALID_PARAMETERSize was NULL.
EFI_BUFFER_TOO_SMALLSize was not large enough to store the line. Size was updated to the minimum space required.

Definition at line 3922 of file UefiShellLib.c.

CHAR16* EFIAPI ShellFileHandleReturnLine ( IN SHELL_FILE_HANDLE  Handle,
IN OUT BOOLEAN Ascii 
)

Function to read a single line from a SHELL_FILE_HANDLE. The
is not included in the returned buffer. The returned buffer must be callee freed.

If the position upon start is 0, then the Ascii Boolean will be set. This should be maintained and not changed for all operations with the same file.

Parameters:
[in]HandleSHELL_FILE_HANDLE to read from.
[in,out]AsciiBoolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE).
Returns:
The line of text from the file.
Return values:
NULLThere was not enough memory available.
See also:
ShellFileHandleReadLine

Definition at line 3867 of file UefiShellLib.c.

CHAR16* EFIAPI ShellFindFilePath ( IN CONST CHAR16 FileName)

Find a file by searching the CWD and then the path.

If FileName is NULL then ASSERT.

If the return value is not NULL then the memory must be caller freed.

Parameters:
FileNameFilename string.
Return values:
NULLthe file was not found
Returns:
!NULL the full path to the file.

Definition at line 1590 of file UefiShellLib.c.

CHAR16* EFIAPI ShellFindFilePathEx ( IN CONST CHAR16 FileName,
IN CONST CHAR16 FileExtension 
)

Find a file by searching the CWD and then the path with a variable set of file extensions. If the file is not found it will append each extension in the list in the order provided and return the first one that is successful.

If FileName is NULL, then ASSERT. If FileExtension is NULL, then behavior is identical to ShellFindFilePath.

If the return value is not NULL then the memory must be caller freed.

Parameters:
[in]FileNameFilename string.
[in]FileExtensionSemi-colon delimeted list of possible extensions.
Return values:
NULLThe file was not found.
!NULLThe path to the file.

Definition at line 1708 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellFindFirstFile ( IN SHELL_FILE_HANDLE  DirHandle,
OUT EFI_FILE_INFO **  Buffer 
)

Retrieve first entry from a directory.

This function takes an open directory handle and gets information from the first entry in the directory. A buffer is allocated to contain the information and a pointer to the buffer is returned in *Buffer. The caller can use ShellFindNextFile() to get subsequent directory entries.

The buffer will be freed by ShellFindNextFile() when the last directory entry is read. Otherwise, the caller must free the buffer, using FreePool, when finished with it.

Parameters:
[in]DirHandleThe file handle of the directory to search.
[out]BufferThe pointer to the buffer for the file's information.
Return values:
EFI_SUCCESSFound the first file.
EFI_NOT_FOUNDCannot find the directory.
EFI_NO_MEDIAThe device has no media.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
Returns:
Others status of ShellGetFileInfo, ShellSetFilePosition, or ShellReadFile

Definition at line 959 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellFindNextFile ( IN SHELL_FILE_HANDLE  DirHandle,
OUT EFI_FILE_INFO Buffer,
OUT BOOLEAN NoFile 
)

Retrieve next entries from a directory.

To use this function, the caller must first call the ShellFindFirstFile() function to get the first directory entry. Subsequent directory entries are retrieved by using the ShellFindNextFile() function. This function can be called several times to get each entry from the directory. If the call of ShellFindNextFile() retrieved the last directory entry, the next call of this function will set *NoFile to TRUE and free the buffer.

Parameters:
[in]DirHandleThe file handle of the directory.
[out]BufferThe pointer to buffer for file's information.
[out]NoFileThe pointer to boolean when last file is found.
Return values:
EFI_SUCCESSFound the next file, or reached last file
EFI_NO_MEDIAThe device has no media.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.

Definition at line 989 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellFindSE2 ( IN EFI_HANDLE  ImageHandle)

Helper function to find ShellEnvironment2 for constructor.

Parameters:
[in]ImageHandleA copy of the calling image's handle.
Return values:
EFI_OUT_OF_RESOURCESMemory allocation failed.

Definition at line 92 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellFlushFile ( IN SHELL_FILE_HANDLE  FileHandle)

Flushes data on a file

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

Parameters:
FileHandleThe file handle on which to flush data
Return values:
EFI_SUCCESSThe data was flushed.
EFI_NO_MEDIAThe device has no media.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write protected.
EFI_ACCESS_DENIEDThe file was opened for read only.

Definition at line 928 of file UefiShellLib.c.

CONST CHAR16* EFIAPI ShellGetCurrentDir ( IN CHAR16 *CONST DeviceName  OPTIONAL)

Retreives the current directory path

If the DeviceName is NULL, it returns the current device's current directory name. If the DeviceName is not NULL, it returns the current directory name on specified drive.

Parameters:
DeviceNamethe name of the drive to get directory on
Return values:
NULLthe directory does not exist
Returns:
!= NULL the directory

Definition at line 1217 of file UefiShellLib.c.

CONST CHAR16* EFIAPI ShellGetEnvironmentVariable ( IN CONST CHAR16 EnvKey)

return the value of an environment variable

this function gets the value of the environment variable set by the ShellSetEnvironmentVariable function

Parameters:
EnvKeyThe key name of the environment variable.
Return values:
NULLthe named environment variable does not exist.
Returns:
!= NULL pointer to the value of the environment variable

Definition at line 1074 of file UefiShellLib.c.

BOOLEAN EFIAPI ShellGetExecutionBreakFlag ( VOID  )

Retrieves the status of the break execution flag

this function is useful to check whether the application is being asked to halt by the shell.

Return values:
TRUEthe execution break is enabled
FALSEthe execution break is not enabled

Definition at line 1034 of file UefiShellLib.c.

EFI_FILE_INFO* EFIAPI ShellGetFileInfo ( IN SHELL_FILE_HANDLE  FileHandle)

This function will retrieve the information about the file for the handle specified and store it in allocated pool memory.

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

Parameters:
FileHandleThe file handle of the file for which information is being requested.
Return values:
NULLinformation could not be retrieved.
Returns:
the information about the file

Definition at line 408 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellGetFilePosition ( IN SHELL_FILE_HANDLE  FileHandle,
OUT UINT64 Position 
)

Gets a file's current position

This function retrieves 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. An error is returned if FileHandle is a directory.

Parameters:
FileHandleThe open file handle on which to get the position.
PositionByte position from begining of file.
Return values:
EFI_SUCCESSthe operation completed sucessfully.
INVALID_PARAMETEROne of the parameters has an invalid value.
EFI_UNSUPPORTEDthe request is not valid on directories.

Definition at line 905 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellGetFileSize ( IN SHELL_FILE_HANDLE  FileHandle,
OUT UINT64 Size 
)

Retrieve the size of a file.

if FileHandle is NULL then ASSERT() if Size is NULL then ASSERT()

This function extracts the file size info from the FileHandle's EFI_FILE_INFO data.

Parameters:
FileHandlefile handle from which size is retrieved
Sizepointer to size
Return values:
EFI_SUCCESSoperation was completed sucessfully
EFI_DEVICE_ERRORcannot access the file

Definition at line 1017 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellInitialize ( )

This function causes the shell library to initialize itself. If the shell library is already initialized it will de-initialize all the current protocol poitners and re-populate them again.

When the library is used with PcdShellLibAutoInitialize set to true this function will return EFI_SUCCESS and perform no actions.

This function is intended for internal access for shell commands only.

Return values:
EFI_SUCCESSthe initialization was complete sucessfully

Definition at line 371 of file UefiShellLib.c.

BOOLEAN EFIAPI ShellIsDecimalDigitCharacter ( IN CHAR16  Char)

Check if a Unicode character is a decimal character.

This internal function checks if a Unicode character is a decimal character. The valid characters are L'0' to L'9'.

Parameters:
CharThe character to check against.
Return values:
TRUEIf the Char is a hexadecmial character.
FALSEIf the Char is not a hexadecmial character.

Definition at line 76 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellIsDirectory ( IN CONST CHAR16 DirName)

Function to determine if a given filename represents a file or a directory.

Parameters:
[in]DirNamePath to directory to test.
Return values:
EFI_SUCCESSThe Path represents a directory
EFI_NOT_FOUNDThe Path does not represent a directory
EFI_OUT_OF_RESOURCESA memory allocation failed.
Returns:
The path failed to open

Definition at line 2878 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellIsFile ( IN CONST CHAR16 Name)

Function to determine if a given filename represents a file.

Parameters:
[in]NamePath to file to test.
Return values:
EFI_SUCCESSThe Path represents a file.
EFI_NOT_FOUNDThe Path does not represent a file.
otherThe path failed to open.

Definition at line 2943 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellIsFileInPath ( IN CONST CHAR16 Name)

Function to determine if a given filename represents a file.

This will search the CWD and then the Path.

If Name is NULL, then ASSERT.

Parameters:
[in]NamePath to file to test.
Return values:
EFI_SUCCESSThe Path represents a file.
EFI_NOT_FOUNDThe Path does not represent a file.
otherThe path failed to open.

Definition at line 2982 of file UefiShellLib.c.

BOOLEAN EFIAPI ShellIsHexaDecimalDigitCharacter ( IN CHAR16  Char)

Check if a Unicode character is a hexadecimal character.

This internal function checks if a Unicode character is a numeric character. The valid hexadecimal characters are L'0' to L'9', L'a' to L'f', or L'A' to L'F'.

Parameters:
CharThe character to check against.
Return values:
TRUEIf the Char is a hexadecmial character.
FALSEIf the Char is not a hexadecmial character.

Definition at line 53 of file UefiShellLib.c.

BOOLEAN EFIAPI ShellIsHexOrDecimalNumber ( IN CONST CHAR16 String,
IN CONST BOOLEAN  ForceHex,
IN CONST BOOLEAN  StopAtSpace 
)

Function to determin if an entire string is a valid number.

If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.

Parameters:
[in]StringThe string to evaluate.
[in]ForceHexTRUE - always assume hex.
[in]StopAtSpaceTRUE to halt upon finding a space, FALSE to keep going.
Return values:
TRUEIt is all numeric (dec/hex) characters.
FALSEThere is a non-numeric character.

Definition at line 3837 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellLibConstructor ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Constructor for the Shell library.

Initialize the library and determine if the underlying is a UEFI Shell 2.0 or an EFI shell.

Parameters:
ImageHandlethe image handle of the process
SystemTablethe EFI System Table pointer
Return values:
EFI_SUCCESSthe initialization was complete sucessfully
Returns:
others an error ocurred during initialization

Definition at line 286 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellLibConstructorWorker ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Function to do most of the work of the constructor. Allows for calling multiple times without complete re-initialization.

Parameters:
[in]ImageHandleA copy of the ImageHandle.
[in]SystemTableA pointer to the SystemTable for the application.
Return values:
EFI_SUCCESSThe operationw as successful.

Definition at line 176 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellLibDestructor ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

Destructor for the library. free any resources.

Parameters:
[in]ImageHandleA copy of the ImageHandle.
[in]SystemTableA pointer to the SystemTable for the application.
Return values:
EFI_SUCCESSThe operation was successful.
Returns:
An error from the CloseProtocol function.

Definition at line 318 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellOpenFileByDevicePath ( IN OUT EFI_DEVICE_PATH_PROTOCOL **  FilePath,
OUT EFI_HANDLE DeviceHandle,
OUT SHELL_FILE_HANDLE FileHandle,
IN UINT64  OpenMode,
IN UINT64  Attributes 
)

This function will open a file or directory referenced by DevicePath.

This function opens a file with the open mode according to the file path. The Attributes is valid only for EFI_FILE_MODE_CREATE.

Parameters:
FilePathon input the device path to the file. On output the remaining device path.
DeviceHandlepointer to the system device handle.
FileHandlepointer to the file handle.
OpenModethe mode to open the file with.
Attributesthe file's file attributes.
Return values:
EFI_SUCCESSThe information was set.
EFI_INVALID_PARAMETEROne of the parameters has an invalid value.
EFI_UNSUPPORTEDCould not open the file path.
EFI_NOT_FOUNDThe specified file could not be found on the device or the file system could not be found on the device.
EFI_NO_MEDIAThe device has no medium.
EFI_MEDIA_CHANGEDThe device has a different medium in it or the medium is no longer supported.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write protected.
EFI_ACCESS_DENIEDThe file was opened read only.
EFI_OUT_OF_RESOURCESNot enough resources were available to open the file.
EFI_VOLUME_FULLThe volume is full.

Definition at line 476 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellOpenFileByName ( IN CONST CHAR16 FileName,
OUT SHELL_FILE_HANDLE FileHandle,
IN UINT64  OpenMode,
IN UINT64  Attributes 
)

This function will open a file or directory referenced by filename.

If return is EFI_SUCCESS, the Filehandle is the opened file's handle; otherwise, the Filehandle is NULL. The Attributes is valid only for EFI_FILE_MODE_CREATE.

if FileName is NULL then ASSERT()

Parameters:
FileNamepointer to file name
FileHandlepointer to the file handle.
OpenModethe mode to open the file with.
Attributesthe file's file attributes.
Return values:
EFI_SUCCESSThe information was set.
EFI_INVALID_PARAMETEROne of the parameters has an invalid value.
EFI_UNSUPPORTEDCould not open the file path.
EFI_NOT_FOUNDThe specified file could not be found on the device or the file system could not be found on the device.
EFI_NO_MEDIAThe device has no medium.
EFI_MEDIA_CHANGEDThe device has a different medium in it or the medium is no longer supported.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write protected.
EFI_ACCESS_DENIEDThe file was opened read only.
EFI_OUT_OF_RESOURCESNot enough resources were available to open the file.
EFI_VOLUME_FULLThe volume is full.

Definition at line 632 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellOpenFileMetaArg ( IN CHAR16 Arg,
IN UINT64  OpenMode,
IN OUT EFI_SHELL_FILE_INFO **  ListHead 
)

Opens a group of files based on a path.

This function uses the Arg to open all the matching files. Each matched file has a SHELL_FILE_ARG structure to record the file information. These structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG structures from ListHead to access each file. This function supports wildcards and will process '?' and '*' as such. the list must be freed with a call to ShellCloseFileMetaArg().

If you are NOT appending to an existing list *ListHead must be NULL. If ListHead is NULL then it must be callee freed.

Parameters:
Argpointer to path string
OpenModemode to open files with
ListHeadhead of linked list of results
Return values:
EFI_SUCCESSthe operation was sucessful and the list head contains the list of opened files
Returns:
!= EFI_SUCCESS the operation failed
See also:
InternalShellConvertFileListType

Definition at line 1440 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellPrintEx ( IN INT32 Col  OPTIONAL,
IN INT32 Row  OPTIONAL,
IN CONST CHAR16 Format,
  ... 
)

Print at a specific location on the screen.

This function will move the cursor to a given screen location and print the specified string.

If -1 is specified for either the Row or Col the current screen location for BOTH will be used.

If either Row or Col is out of range for the current console, then ASSERT. If Format is NULL, then ASSERT.

In addition to the standard -based flags as supported by UefiLib Print() this supports the following additional flags: N - Set output attribute to normal H - Set output attribute to highlight E - Set output attribute to error B - Set output attribute to blue color V - Set output attribute to green color

Note: The background color is controlled by the shell command cls.

Parameters:
[in]Colthe column to print at
[in]Rowthe row to print at
[in]Formatthe format string
[in]...The variable argument list.
Returns:
EFI_SUCCESS The printing was successful.
EFI_DEVICE_ERROR The console device reported an error.

Definition at line 2789 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellPrintHiiEx ( IN INT32 Col  OPTIONAL,
IN INT32 Row  OPTIONAL,
IN CONST CHAR8 *Language  OPTIONAL,
IN CONST EFI_STRING_ID  HiiFormatStringId,
IN CONST EFI_HANDLE  HiiFormatHandle,
  ... 
)

Print at a specific location on the screen.

This function will move the cursor to a given screen location and print the specified string.

If -1 is specified for either the Row or Col the current screen location for BOTH will be used.

If either Row or Col is out of range for the current console, then ASSERT. If Format is NULL, then ASSERT.

In addition to the standard -based flags as supported by UefiLib Print() this supports the following additional flags: N - Set output attribute to normal. H - Set output attribute to highlight. E - Set output attribute to error. B - Set output attribute to blue color. V - Set output attribute to green color.

Note: The background color is controlled by the shell command cls.

Parameters:
[in]ColThe column to print at.
[in]RowThe row to print at.
[in]LanguageThe language of the string to retrieve. If this parameter is NULL, then the current platform language is used.
[in]HiiFormatStringIdThe format string Id for getting from Hii.
[in]HiiFormatHandleThe format string Handle for getting from Hii.
[in]...The variable argument list.
Returns:
EFI_SUCCESS The printing was successful.
EFI_DEVICE_ERROR The console device reported an error.

Definition at line 2841 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellPromptForResponse ( IN SHELL_PROMPT_REQUEST_TYPE  Type,
IN CHAR16 *Prompt  OPTIONAL,
IN OUT VOID **Response  OPTIONAL 
)

Prompt the user and return the resultant answer to the requestor.

This function will display the requested question on the shell prompt and then wait for an apropriate answer to be input from the console.

if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.

if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type CHAR16*.

In either case *Response must be callee freed if Response was not NULL;

Parameters:
TypeWhat type of question is asked. This is used to filter the input to prevent invalid answers to question.
PromptPointer to string prompt to use to request input.
ResponsePointer to Response which will be populated upon return.
Return values:
EFI_SUCCESSThe operation was sucessful.
EFI_UNSUPPORTEDThe operation is not supported as requested.
EFI_INVALID_PARAMETERA parameter was invalid.
Returns:
other The operation failed.

Definition at line 3163 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellPromptForResponseHii ( IN SHELL_PROMPT_REQUEST_TYPE  Type,
IN CONST EFI_STRING_ID  HiiFormatStringId,
IN CONST EFI_HANDLE  HiiFormatHandle,
IN OUT VOID **  Response 
)

Prompt the user and return the resultant answer to the requestor.

This function is the same as ShellPromptForResponse, except that the prompt is automatically pulled from HII.

Parameters:
TypeWhat type of question is asked. This is used to filter the input to prevent invalid answers to question.
[in]HiiFormatStringIdThe format string Id for getting from Hii.
[in]HiiFormatHandleThe format string Handle for getting from Hii.
ResponsePointer to Response which will be populated upon return.
Return values:
EFI_SUCCESSthe operation was sucessful.
Returns:
other the operation failed.
See also:
ShellPromptForResponse

Definition at line 3380 of file UefiShellLib.c.

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

This function reads information from an opened 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, the function reads the directory entry at the file's current position and returns the entry in Buffer. If the Buffer is not large enough to hold the current directory entry, then EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. BufferSize is set to be the size of the buffer needed to read the entry. On success, the current position is updated to the next directory entry. If there are no more directory entries, the read returns a zero-length buffer. EFI_FILE_INFO is the structure returned as the directory entry.

Parameters:
FileHandlethe opened file handle
BufferSizeon input the size of buffer in bytes. on return the number of bytes written.
Bufferthe buffer to put read data into.
Return values:
EFI_SUCCESSData was read.
EFI_NO_MEDIAThe device has no media.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_BUFFER_TO_SMALLBuffer is too small. ReadSize contains required size.

Definition at line 771 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellSetEnvironmentVariable ( IN CONST CHAR16 EnvKey,
IN CONST CHAR16 EnvVal,
IN BOOLEAN  Volatile 
)

set the value of an 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.

This is not supported pre-UEFI Shell 2.0.

Parameters:
EnvKeyThe key name of the environment variable.
EnvValThe Value of the environment variable
VolatileIndicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
Return values:
EFI_SUCCESSthe operation was completed sucessfully
EFI_UNSUPPORTEDThis operation is not allowed in pre UEFI 2.0 Shell environments

Definition at line 1116 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellSetFileInfo ( IN SHELL_FILE_HANDLE  FileHandle,
IN EFI_FILE_INFO FileInfo 
)

This function sets the information about the file for the opened handle specified.

Parameters:
[in]FileHandleThe file handle of the file for which information is being set.
[in]FileInfoThe information to set.
Return values:
EFI_SUCCESSThe information was set.
EFI_INVALID_PARAMETERA parameter was out of range or invalid.
EFI_UNSUPPORTEDThe FileHandle does not support FileInfo.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write protected.
EFI_ACCESS_DENIEDThe file was opened read only.
EFI_VOLUME_FULLThe volume is full.

Definition at line 436 of file UefiShellLib.c.

EFI_STATUS EFIAPI ShellSetFilePosition ( IN SHELL_FILE_HANDLE  FileHandle,
IN UINT64  Position 
)

Set the current position in a file.

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. If FileHandle is a directory, the only position that may be set is zero. This has the effect of starting the read process of the directory entries over.

Parameters:
FileHandleThe file handle on which the position is being set
PositionByte position from begining of file
Return values:
EFI_SUCCESSOperation completed sucessfully.
EFI_UNSUPPORTEDthe seek request for non-zero is not valid on directories.
INVALID_PARAMETEROne of the parameters has an invalid value.

Definition at line 880 of file UefiShellLib.c.

VOID EFIAPI ShellSetPageBreakMode ( IN BOOLEAN  CurrentState)

sets (enabled or disabled) the page break mode

when page break mode is enabled the screen will stop scrolling and wait for operator input before scrolling a subsequent screen.

Parameters:
CurrentStateTRUE to enable and FALSE to disable

Definition at line 1247 of file UefiShellLib.c.

UINTN EFIAPI ShellStrToUintn ( IN CONST CHAR16 String)

Function to determine whether a string is decimal or hex representation of a number and return the number converted from the string.

Parameters:
[in]StringString representation of a number
Returns:
the number
Return values:
(UINTN)(-1)An error ocurred.

Definition at line 3013 of file UefiShellLib.c.

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

Write data to a 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 is automatically grown to hold the data if required. Direct writes to opened directories are not supported.

Parameters:
FileHandleThe opened file for writing
BufferSizeon input the number of bytes in Buffer. On output the number of bytes written.
Bufferthe buffer containing data to write is stored.
Return values:
EFI_SUCCESSData was written.
EFI_UNSUPPORTEDWrites to an open directory are not supported.
EFI_NO_MEDIAThe device has no media.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe device is write-protected.
EFI_ACCESS_DENIEDThe file was open for read only.
EFI_VOLUME_FULLThe volume is full.

Definition at line 807 of file UefiShellLib.c.

CHAR16* EFIAPI StrnCatGrow ( IN OUT CHAR16 **  Destination,
IN OUT UINTN CurrentSize,
IN CONST CHAR16 Source,
IN UINTN  Count 
)

Safely append with automatic string resizing given length of Destination and desired length of copy from Source.

append the first D characters of Source to the end of Destination, where D is the lesser of Count and the StrLen() of Source. If appending those D characters will fit within Destination (whose Size is given as CurrentSize) and still leave room for a NULL terminator, then those characters are appended, starting at the original terminating NULL of Destination, and a new terminating NULL is appended.

If appending D characters onto Destination will result in a overflow of the size given in CurrentSize the string will be grown such that the copy can be performed and CurrentSize will be updated to the new size.

If Source is NULL, there is nothing to append, just return the current buffer in Destination.

if Destination is NULL, then ASSERT() if Destination's current length (including NULL terminator) is already more then CurrentSize, then ASSERT()

Parameters:
[in,out]DestinationThe String to append onto
[in,out]CurrentSizeon call the number of bytes in Destination. On return possibly the new size (still in bytes). if NULL then allocate whatever is needed.
[in]SourceThe String to append from
[in]CountMaximum number of characters to append. if 0 then all are appended.
Returns:
Destination return the resultant string.

Definition at line 3066 of file UefiShellLib.c.


Variable Documentation

Initial value:
 {
  {NULL, TypeMax}
  }

Helper structure for no parameters (besides -? and -b)

Definition at line 24 of file UefiShellLib.c.

Definition at line 36 of file UefiShellLib.c.

Definition at line 34 of file UefiShellLib.c.

Definition at line 33 of file UefiShellLib.c.

Definition at line 31 of file UefiShellLib.c.

Definition at line 35 of file UefiShellLib.c.

Definition at line 32 of file UefiShellLib.c.

Initial value:
 {
  {L"-sfo", TypeFlag},
  {NULL, TypeMax}
  }

Helper structure for -sfo only (besides -? and -b)

Definition at line 27 of file UefiShellLib.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines