mirror of https://github.com/acidanthera/audk.git
comment repairs.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9460 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
23bb88ecb5
commit
a31bd33cf8
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
GUID for EFI shell Environment2 Extension
|
||||
|
||||
Copyright (c) 2009, Intel Corporation
|
||||
Copyright (c) 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
GUID for ShellPkg PCD Token Space.
|
||||
|
||||
Copyright (c) 2009, Intel Corporation
|
||||
Copyright (c) 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Provides interface to EFI_FILE_HANDLE functionality.
|
||||
|
||||
Copyright (c) 2009, Intel Corporation
|
||||
Copyright (c) 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
@ -74,7 +74,7 @@ FileHandleSetInfo (
|
|||
EFI_FILE_INFO is the structure returned as the directory entry.
|
||||
|
||||
@param FileHandle The opened file handle.
|
||||
@param BufferSize On input the size of buffer in bytes. on return
|
||||
@param BufferSize On input the size of buffer in bytes. On return
|
||||
the number of bytes written.
|
||||
@param Buffer The buffer to put read data into.
|
||||
|
||||
|
@ -104,19 +104,19 @@ FileHandleRead(
|
|||
The file is automatically grown to hold the data if required. Direct writes to
|
||||
opened directories are not supported.
|
||||
|
||||
@param FileHandle The opened file for writing
|
||||
@param BufferSize On input the number of bytes in Buffer. On output
|
||||
the number of bytes written.
|
||||
@param Buffer The buffer containing data to write is stored.
|
||||
@param FileHandle The opened file for writing
|
||||
@param BufferSize On input the number of bytes in Buffer. On output
|
||||
the number of bytes written.
|
||||
@param Buffer The buffer containing data to write is stored.
|
||||
|
||||
@retval EFI_SUCCESS Data was written.
|
||||
@retval EFI_UNSUPPORTED Writes to an open directory are not supported.
|
||||
@retval EFI_SUCCESS Data was written.
|
||||
@retval EFI_UNSUPPORTED Writes to an open directory are not supported.
|
||||
@retval EFI_NO_MEDIA The device has no media.
|
||||
@retval EFI_DEVICE_ERROR The device reported an error.
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
|
||||
@retval EFI_WRITE_PROTECTED The device is write-protected.
|
||||
@retval EFI_ACCESS_DENIED The file was open for read only.
|
||||
@retval EFI_VOLUME_FULL The volume is full.
|
||||
@retval EFI_WRITE_PROTECTED The device is write-protected.
|
||||
@retval EFI_ACCESS_DENIED The file was open for read only.
|
||||
@retval EFI_VOLUME_FULL The volume is full.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Provides application point extension for "C" style main funciton
|
||||
|
||||
Copyright (c) 2006 - 2009, Intel Corporation
|
||||
Copyright (c) 2006 - 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Provides interface to shell functionality for shell commands and applications.
|
||||
|
||||
Copyright (c) 2006 - 2009, Intel Corporation
|
||||
Copyright (c) 2006 - 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
@ -416,7 +416,7 @@ ShellFindNextFile(
|
|||
@param Size Pointer to size.
|
||||
|
||||
@retval EFI_SUCCESS The operation was completed sucessfully.
|
||||
@retval EFI_DEVICE_ERROR cannot access the file.
|
||||
@retval EFI_DEVICE_ERROR Cannot access the file.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
@ -447,7 +447,7 @@ ShellGetExecutionBreakFlag(
|
|||
|
||||
@param EnvKey The key name of the environment variable.
|
||||
|
||||
@retval NULL the named environment variable does not exist.
|
||||
@retval NULL The named environment variable does not exist.
|
||||
@return != NULL pointer to the value of the environment variable.
|
||||
**/
|
||||
CONST CHAR16*
|
||||
|
@ -499,18 +499,18 @@ ShellSetEnvironmentVariable (
|
|||
EnvironmentVariables and Status are only supported for UEFI Shell 2.0.
|
||||
Output is only supported for pre-UEFI Shell 2.0
|
||||
|
||||
@param ImageHandle Parent image that is starting the operation
|
||||
@param CommandLine pointer to null terminated command line.
|
||||
@param Output true to display debug output. false to hide it.
|
||||
@param EnvironmentVariables optional pointer to array of environment variables
|
||||
in the form "x=y". if NULL current set is used.
|
||||
@param Status the status of the run command line.
|
||||
@param ImageHandle Parent image that is starting the operation.
|
||||
@param CommandLine Pointer to null terminated command line.
|
||||
@param Output True to display debug output. false to hide it.
|
||||
@param EnvironmentVariables Optional pointer to array of environment variables
|
||||
in the form "x=y". If NULL current set is used.
|
||||
@param Status The status of the run command line.
|
||||
|
||||
@retval EFI_SUCCESS the operation completed sucessfully. Status
|
||||
@retval EFI_SUCCESS The operation completed sucessfully. Status
|
||||
contains the status code returned.
|
||||
@retval EFI_INVALID_PARAMETER a parameter contains an invalid value
|
||||
@retval EFI_OUT_OF_RESOURCES out of resources
|
||||
@retval EFI_UNSUPPORTED the operation is not allowed.
|
||||
@retval EFI_INVALID_PARAMETER A parameter contains an invalid value.
|
||||
@retval EFI_OUT_OF_RESOURCES Out of resources.
|
||||
@retval EFI_UNSUPPORTED The operation is not allowed.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
@ -523,16 +523,16 @@ ShellExecute (
|
|||
);
|
||||
|
||||
/**
|
||||
Retreives the current directory path
|
||||
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.
|
||||
|
||||
@param DeviceName the name of the drive to get directory on
|
||||
@param DeviceName The name of the file system to get directory on.
|
||||
|
||||
@retval NULL the directory does not exist
|
||||
@return != NULL the directory
|
||||
@retval NULL The directory does not exist.
|
||||
@return != NULL The directory.
|
||||
**/
|
||||
CONST CHAR16*
|
||||
EFIAPI
|
||||
|
@ -546,7 +546,7 @@ ShellGetCurrentDir (
|
|||
When page break mode is enabled the screen will stop scrolling
|
||||
and wait for operator input before scrolling a subsequent screen.
|
||||
|
||||
@param CurrentState TRUE to enable and FALSE to disable
|
||||
@param CurrentState TRUE to enable and FALSE to disable.
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
|
@ -573,7 +573,7 @@ ShellSetPageBreakMode (
|
|||
|
||||
@retval EFI_SUCCESS The operation was sucessful and the list head
|
||||
contains the list of opened files.
|
||||
@return != EFI_SUCCESS The operation failed.
|
||||
@retval != EFI_SUCCESS The operation failed.
|
||||
|
||||
@sa InternalShellConvertFileListType
|
||||
**/
|
||||
|
@ -586,12 +586,12 @@ ShellOpenFileMetaArg (
|
|||
);
|
||||
|
||||
/**
|
||||
Free the linked list returned from ShellOpenFileMetaArg
|
||||
Free the linked list returned from ShellOpenFileMetaArg.
|
||||
|
||||
@param ListHead the pointer to free
|
||||
@param ListHead The pointer to free.
|
||||
|
||||
@retval EFI_SUCCESS the operation was sucessful
|
||||
@retval EFI_INVALID_PARAMETER A parameter was invalid
|
||||
@retval EFI_SUCCESS The operation was sucessful.
|
||||
@retval EFI_INVALID_PARAMETER A parameter was invalid.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
@ -602,14 +602,14 @@ ShellCloseFileMetaArg (
|
|||
/**
|
||||
Find a file by searching the CWD and then the path.
|
||||
|
||||
if FileName is NULL then ASSERT.
|
||||
If FileName is NULL, then ASSERT.
|
||||
|
||||
if the return value is not NULL then the memory must be caller freed.
|
||||
If the return value is not NULL then the memory must be caller freed.
|
||||
|
||||
@param FileName Filename string.
|
||||
|
||||
@retval NULL the file was not found
|
||||
@return !NULL the path to the file.
|
||||
@retval NULL The file was not found.
|
||||
@return !NULL The path to the file.
|
||||
**/
|
||||
CHAR16 *
|
||||
EFIAPI
|
||||
|
@ -618,12 +618,12 @@ ShellFindFilePath (
|
|||
);
|
||||
|
||||
typedef enum {
|
||||
TypeFlag = 0, /// a flag that is present or not present only. (IE "-a")
|
||||
TypeValue, /// a flag that has some data following it with a space (IE "-a 1")
|
||||
TypePosition, /// some data that did not follow a parameter (IE "filename.txt")
|
||||
TypeStart, /// a flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...
|
||||
TypeDoubleValue, /// a flag that has 2 space seperated value data following it. (IE "-a 1 2")
|
||||
TypeMaxValue, /// a flag followed by all the command line data before the next flag.
|
||||
TypeFlag = 0, ///< a flag that is present or not present only (IE "-a").
|
||||
TypeValue, ///< a flag that has some data following it with a space (IE "-a 1").
|
||||
TypePosition, ///< some data that did not follow a parameter (IE "filename.txt").
|
||||
TypeStart, ///< a flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...).
|
||||
TypeDoubleValue, ///< a flag that has 2 space seperated value data following it (IE "-a 1 2").
|
||||
TypeMaxValue, ///< a flag followed by all the command line data before the next flag.
|
||||
TypeMax,
|
||||
} ParamType;
|
||||
|
||||
|
@ -644,21 +644,21 @@ extern SHELL_PARAM_ITEM EmptyParamList[];
|
|||
|
||||
@param CheckList Pointer to list of parameters to check.
|
||||
@param CheckPackage Package of checked values.
|
||||
@param ProblemParam Pptional pointer to pointer to unicode string for
|
||||
@param ProblemParam Optional pointer to pointer to unicode string for
|
||||
the paramater that caused failure.
|
||||
@param AutoPageBreak Will automatically set PageBreakEnabled.
|
||||
|
||||
@retval EFI_SUCCESS The operation completed sucessfully.
|
||||
@retval EFI_OUT_OF_RESOURCES A memory allocation failed
|
||||
@retval EFI_INVALID_PARAMETER A parameter was invalid
|
||||
@retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
|
||||
duplicated. the duplicated command line argument
|
||||
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
|
||||
@retval EFI_INVALID_PARAMETER A parameter was invalid.
|
||||
@retval EFI_VOLUME_CORRUPTED The command line was corrupt. an argument was
|
||||
duplicated. The duplicated command line argument
|
||||
was returned in ProblemParam if provided.
|
||||
@retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. one
|
||||
@retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
|
||||
of the command line arguments was returned in
|
||||
ProblemParam if provided.
|
||||
@retval EFI_NOT_FOUND A argument required a value that was missing.
|
||||
the invalid command line argument was returned in
|
||||
The invalid command line argument was returned in
|
||||
ProblemParam if provided.
|
||||
**/
|
||||
EFI_STATUS
|
||||
|
@ -671,7 +671,7 @@ ShellCommandLineParseEx (
|
|||
IN BOOLEAN AlwaysAllowNumbers
|
||||
);
|
||||
|
||||
// make it easy to upgrade from older versions of the shell library.
|
||||
/// make it easy to upgrade from older versions of the shell library.
|
||||
#define ShellCommandLineParse(CheckList,CheckPackage,ProblemParam,AutoPageBreak) ShellCommandLineParseEx(CheckList,CheckPackage,ProblemParam,AutoPageBreak,FALSE)
|
||||
|
||||
/**
|
||||
|
@ -680,11 +680,9 @@ ShellCommandLineParseEx (
|
|||
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.
|
||||
|
||||
if CheckPackage is NULL, then return
|
||||
|
||||
@param CheckPackage the list to de-allocate
|
||||
@param CheckPackage The list to de-allocate.
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
|
@ -693,18 +691,18 @@ ShellCommandLineFreeVarList (
|
|||
);
|
||||
|
||||
/**
|
||||
Checks for presence of a flag parameter
|
||||
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()
|
||||
if KeyString is NULL then ASSERT().
|
||||
|
||||
@param CheckPackage The package of parsed command line arguments
|
||||
@param KeyString the Key of the command line argument to check for
|
||||
@param CheckPackage The package of parsed command line arguments.
|
||||
@param KeyString The Key of the command line argument to check for.
|
||||
|
||||
@retval TRUE the flag is on the command line
|
||||
@retval FALSE the flag is not on the command line
|
||||
@retval TRUE The flag is on the command line.
|
||||
@retval FALSE The flag is not on the command line.
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
|
@ -714,17 +712,17 @@ ShellCommandLineGetFlag (
|
|||
);
|
||||
|
||||
/**
|
||||
returns value from command line argument
|
||||
Returns value from command line argument.
|
||||
|
||||
value parameters are in the form of "-<Key> value" or "/<Key> value"
|
||||
Value parameters are in the form of "-<Key> value" or "/<Key> value"
|
||||
|
||||
if CheckPackage is NULL, then return NULL;
|
||||
If CheckPackage is NULL, then return NULL.
|
||||
|
||||
@param CheckPackage The package of parsed command line arguments
|
||||
@param KeyString the Key of the command line argument to check for
|
||||
@param CheckPackage The package of parsed command line arguments.
|
||||
@param KeyString The Key of the command line argument to check for.
|
||||
|
||||
@retval NULL the flag is not on the command line
|
||||
@return !=NULL pointer to unicode string of the value
|
||||
@retval NULL The flag is not on the command line.
|
||||
@retval !=NULL Pointer to unicode string of the value.
|
||||
**/
|
||||
CONST CHAR16*
|
||||
EFIAPI
|
||||
|
@ -734,17 +732,17 @@ ShellCommandLineGetValue (
|
|||
);
|
||||
|
||||
/**
|
||||
returns raw value from command line argument
|
||||
Returns raw value from command line argument.
|
||||
|
||||
raw value parameters are in the form of "value" in a specific position in the list
|
||||
Raw value parameters are in the form of "value" in a specific position in the list.
|
||||
|
||||
if CheckPackage is NULL, then return NULL;
|
||||
If CheckPackage is NULL, then return NULL;
|
||||
|
||||
@param CheckPackage The package of parsed command line arguments
|
||||
@param Position the position of the value
|
||||
@param CheckPackage The package of parsed command line arguments.
|
||||
@param Position The position of the value.
|
||||
|
||||
@retval NULL the flag is not on the command line
|
||||
@return !=NULL pointer to unicode string of the value
|
||||
@retval NULL The flag is not on the command line.
|
||||
@retval !=NULL Pointer to unicode string of the value.
|
||||
**/
|
||||
CONST CHAR16*
|
||||
EFIAPI
|
||||
|
@ -754,12 +752,12 @@ ShellCommandLineGetRawValue (
|
|||
);
|
||||
|
||||
/**
|
||||
returns the number of command line value parameters that were parsed.
|
||||
Returns the number of command line value parameters that were parsed.
|
||||
|
||||
this will not include flags.
|
||||
This will not include flags.
|
||||
|
||||
@retval (UINTN)-1 No parsing has ocurred
|
||||
@return other The number of value parameters found
|
||||
@return The number of value parameters found
|
||||
**/
|
||||
UINTN
|
||||
EFIAPI
|
||||
|
@ -790,13 +788,13 @@ ShellInitialize (
|
|||
Print at a specific location on the screen.
|
||||
|
||||
This function will move the cursor to a given screen location, print the specified string,
|
||||
and return the cursor to the original locaiton.
|
||||
and return the cursor to the original location.
|
||||
|
||||
If -1 is specified for either the Row or Col the current screen location for BOTH
|
||||
will be used and the cursor's position will not be moved back to an original location.
|
||||
|
||||
if either Row or Col is out of range for the current console, then ASSERT
|
||||
if Format is NULL, then ASSERT
|
||||
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:
|
||||
|
@ -864,13 +862,13 @@ ShellPrintHiiEx(
|
|||
);
|
||||
|
||||
/**
|
||||
Function to determine if a given filename represents a file or a directory.
|
||||
Function to determine if a given filename represents a directory.
|
||||
|
||||
@param[in] DirName Path to directory to test.
|
||||
|
||||
@retval EFI_SUCCESS The Path represents a directory
|
||||
@retval EFI_NOT_FOUND The Path does not represent a directory
|
||||
@return other The path failed to open
|
||||
@retval EFI_SUCCESS The Path represents a directory.
|
||||
@retval EFI_NOT_FOUND The Path does not represent a directory.
|
||||
@retval other The path failed to open.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
@ -878,13 +876,28 @@ ShellIsDirectory(
|
|||
IN CONST CHAR16 *DirName
|
||||
);
|
||||
|
||||
/**
|
||||
Function to determine if a given filename represents a file.
|
||||
|
||||
@param[in] Name Path to file to test.
|
||||
|
||||
@retval EFI_SUCCESS The Path represents a file.
|
||||
@retval EFI_NOT_FOUND The Path does not represent a file.
|
||||
@retval other The path failed to open.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
ShellIsFile(
|
||||
IN CONST CHAR16 *Name
|
||||
);
|
||||
|
||||
/**
|
||||
Function to determine whether a string is decimal or hex representation of a number
|
||||
and return the number converted from the string.
|
||||
|
||||
@param[in] String String representation of a number
|
||||
|
||||
@retval all the number
|
||||
@return The unsigned integer result of the conversion.
|
||||
**/
|
||||
UINTN
|
||||
EFIAPI
|
||||
|
@ -896,7 +909,7 @@ ShellStrToUintn(
|
|||
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
|
||||
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,
|
||||
|
@ -910,19 +923,19 @@ ShellStrToUintn(
|
|||
If Source is NULL, there is nothing to append, just return the current buffer in
|
||||
Destination.
|
||||
|
||||
if Destination is NULL, then ASSERT()
|
||||
if Destination is NULL, then ASSERT().
|
||||
if Destination's current length (including NULL terminator) is already more then
|
||||
CurrentSize, then ASSERT()
|
||||
CurrentSize, then ASSERT().
|
||||
|
||||
@param[in,out] Destination The String to append onto
|
||||
@param[in,out] CurrentSize on call the number of bytes in Destination. On
|
||||
@param[in,out] Destination The String to append onto.
|
||||
@param[in,out] CurrentSize On call the number of bytes in Destination. On
|
||||
return possibly the new size (still in bytes). if NULL
|
||||
then allocate whatever is needed.
|
||||
@param[in] Source The String to append from
|
||||
@param[in] Count Maximum number of characters to append. if 0 then
|
||||
@param[in] Source The String to append from.
|
||||
@param[in] Count Maximum number of characters to append. If 0 then
|
||||
all are appended.
|
||||
|
||||
@return Destination return the resultant string.
|
||||
@return the Destination after apending the Source.
|
||||
**/
|
||||
CHAR16*
|
||||
EFIAPI
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Library used for sorting and comparison routines.
|
||||
|
||||
Copyright (c) 2009, Intel Corporation
|
||||
Copyright (c) 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
@ -18,12 +18,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|||
/**
|
||||
Prototype for comparison function for any 2 element types.
|
||||
|
||||
@param[in] Buffer1 pointer to first buffer
|
||||
@param[in] Buffer2 pointer to second buffer
|
||||
@param[in] Buffer1 Pointer to first buffer.
|
||||
@param[in] Buffer2 Pointer to second buffer.
|
||||
|
||||
@retval 0 Buffer1 equal to Buffer2
|
||||
@return < 0 Buffer1 is less than Buffer2
|
||||
@return > 0 Buffer1 is greater than Buffer2
|
||||
@retval 0 Buffer1 equal to Buffer2.
|
||||
@return < 0 Buffer1 is less than Buffer2.
|
||||
@return > 0 Buffer1 is greater than Buffer2.
|
||||
**/
|
||||
typedef
|
||||
INTN
|
||||
|
@ -37,18 +37,18 @@ INTN
|
|||
|
||||
Each element must be equally sized.
|
||||
|
||||
if BufferToSort is NULL, then ASSERT.
|
||||
if CompareFunction is NULL, then ASSERT.
|
||||
If BufferToSort is NULL, then ASSERT.
|
||||
If CompareFunction is NULL, then ASSERT.
|
||||
|
||||
if Count is < 2 then perform no action.
|
||||
if Size is < 1 then perform no action.
|
||||
If Count is < 2 then perform no action.
|
||||
If Size is < 1 then perform no action.
|
||||
|
||||
@param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements
|
||||
on return a buffer of sorted elements
|
||||
@param[in] Count the number of elements in the buffer to sort
|
||||
@param[in] ElementSize Size of an element in bytes
|
||||
@param[in,out] BufferToSort On call a Buffer of (possibly sorted) elements
|
||||
on return a buffer of sorted elements.
|
||||
@param[in] Count The number of elements in the buffer to sort
|
||||
@param[in] ElementSize Size of an element in bytes.
|
||||
@param[in] CompareFunction The function to call to perform the comparison
|
||||
of any 2 elements
|
||||
of any 2 elements.
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
|
|
|
@ -26,13 +26,14 @@
|
|||
// replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.
|
||||
// they are identical outside of the name.
|
||||
typedef struct {
|
||||
LIST_ENTRY Link; ///< Linked list members
|
||||
EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.
|
||||
CONST CHAR16 *FullName; ///< Fully qualified filename.
|
||||
CONST CHAR16 *FileName; ///< name of this file.
|
||||
EFI_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.
|
||||
EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.
|
||||
LIST_ENTRY Link; ///< Linked list members.
|
||||
EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.
|
||||
CONST CHAR16 *FullName; ///< Fully qualified filename.
|
||||
CONST CHAR16 *FileName; ///< name of this file.
|
||||
EFI_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.
|
||||
EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.
|
||||
} EFI_SHELL_FILE_INFO;
|
||||
|
||||
/**
|
||||
Returns whether any script files are currently being processed.
|
||||
|
||||
|
@ -53,9 +54,9 @@ BOOLEAN
|
|||
flushed to the device, and the file is closed. In all cases, the handle is
|
||||
closed.
|
||||
|
||||
@param[in] FileHandle The file handle to be closed
|
||||
@param[in] FileHandle The file handle to be closed
|
||||
|
||||
@retval EFI_SUCCESS the file closed sucessfully
|
||||
@retval EFI_SUCCESS The file closed sucessfully.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
|
@ -77,27 +78,27 @@ EFI_STATUS
|
|||
shell environment variable with the specified name. If the shell environment variable
|
||||
already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
|
||||
|
||||
@param[in] FileName Pointer to null-terminated file path
|
||||
@param[in] FileAttribs The new file's attrbiutes. the different attributes are
|
||||
described in EFI_FILE_PROTOCOL.Open().
|
||||
@param[out] FileHandle On return, points to the created file handle or directory's handle
|
||||
@param[in] FileName Pointer to null-terminated file path.
|
||||
@param[in] FileAttribs The new file's attrbiutes. the different attributes are
|
||||
described in EFI_FILE_PROTOCOL.Open().
|
||||
@param[out] FileHandle On return, points to the created file handle or directory's handle
|
||||
|
||||
@retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
|
||||
@retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
|
||||
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
|
||||
@retval EFI_UNSUPPORTED could not open the file path
|
||||
@retval EFI_NOT_FOUND The specified file could not be found on the device, or could not
|
||||
file the file system on the device.
|
||||
@retval EFI_NO_MEDIA the device has no medium.
|
||||
@retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
|
||||
longer supported.
|
||||
@retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
|
||||
the DirName.
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
|
||||
@retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
|
||||
when the media is write-protected.
|
||||
@retval EFI_ACCESS_DENIED The service denied access to the file.
|
||||
@retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
|
||||
@retval EFI_VOLUME_FULL The volume is full.
|
||||
@retval EFI_UNSUPPORTED could not open the file path
|
||||
@retval EFI_NOT_FOUND The specified file could not be found on the device, or could not
|
||||
file the file system on the device.
|
||||
@retval EFI_NO_MEDIA The device has no medium.
|
||||
@retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
|
||||
longer supported.
|
||||
@retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
|
||||
the DirName.
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
|
||||
@retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
|
||||
when the media is write-protected.
|
||||
@retval EFI_ACCESS_DENIED The service denied access to the file.
|
||||
@retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
|
||||
@retval EFI_VOLUME_FULL The volume is full.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
|
@ -116,7 +117,7 @@ EFI_STATUS
|
|||
|
||||
@param[in] FileHandle The file handle to delete.
|
||||
|
||||
@retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
|
||||
@retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
|
||||
@retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
|
||||
**/
|
||||
typedef
|
||||
|
@ -216,9 +217,9 @@ EFI_STATUS
|
|||
|
||||
@retval EFI_SUCCESS Files found.
|
||||
@retval EFI_NOT_FOUND No files found.
|
||||
@retval EFI_NO_MEDIA The device has no media
|
||||
@retval EFI_DEVICE_ERROR The device reported an error
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
|
||||
@retval EFI_NO_MEDIA The device has no media.
|
||||
@retval EFI_DEVICE_ERROR The device reported an error.
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
|
@ -247,11 +248,11 @@ OUT EFI_SHELL_FILE_INFO **FileList
|
|||
);
|
||||
|
||||
/**
|
||||
Flushes data back to a device
|
||||
Flushes data back to a device.
|
||||
|
||||
This function flushes all modified data associated with a file to a device.
|
||||
|
||||
@param[in] FileHandle The handle of the file to flush
|
||||
@param[in] FileHandle The handle of the file to flush
|
||||
|
||||
@retval EFI_SUCCESS The data was flushed.
|
||||
@retval EFI_NO_MEDIA The device has no medium.
|
||||
|
@ -273,7 +274,7 @@ EFI_STATUS
|
|||
This function cleans up the file list and any related data structures. It has no
|
||||
impact on the files themselves.
|
||||
|
||||
@param[in] FileList The file list to free. Type EFI_SHELL_FILE_INFO is
|
||||
@param[in] FileList The file list to free. Type EFI_SHELL_FILE_INFO is
|
||||
defined in OpenFileList()
|
||||
|
||||
@retval EFI_SUCCESS Free the file list successfully.
|
||||
|
@ -292,7 +293,7 @@ EFI_STATUS
|
|||
FileSystemMapping. In both cases, the returned name includes the file system
|
||||
mapping (i.e. fs0:\current-dir).
|
||||
|
||||
@param[in] FileSystemMapping A pointer to the file system mapping. If NULL,
|
||||
@param[in] FileSystemMapping A pointer to the file system mapping. If NULL,
|
||||
then the current working directory is returned.
|
||||
|
||||
@retval !=NULL The current directory.
|
||||
|
@ -307,6 +308,7 @@ CONST CHAR16 *
|
|||
typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS;
|
||||
#define EFI_DEVICE_NAME_USE_COMPONENT_NAME 0x00000001
|
||||
#define EFI_DEVICE_NAME_USE_DEVICE_PATH 0x00000002
|
||||
|
||||
/**
|
||||
Gets the name of the device specified by the device handle.
|
||||
|
||||
|
@ -328,7 +330,7 @@ typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS;
|
|||
@param[in] Flags Determines the possible sources of component names.
|
||||
@param[in] Language A pointer to the language specified for the device
|
||||
name, in the same format as described in the UEFI
|
||||
specification, Appendix M
|
||||
specification, Appendix M.
|
||||
@param[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
|
||||
|
@ -371,9 +373,9 @@ CONST EFI_DEVICE_PATH_PROTOCOL *
|
|||
This function converts a file system style name to a device path, by replacing any
|
||||
mapping references to the associated device path.
|
||||
|
||||
@param[in] Path the pointer to the path
|
||||
@param[in] Path The pointer to the path.
|
||||
|
||||
@return all The pointer of the file path. The file path is callee
|
||||
@return The pointer of the file path. The file path is callee
|
||||
allocated and should be freed by the caller.
|
||||
**/
|
||||
typedef
|
||||
|
@ -393,7 +395,7 @@ EFI_DEVICE_PATH_PROTOCOL *
|
|||
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.
|
||||
|
||||
@param[in] Name A pointer to the environment variable name. If
|
||||
@param[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
|
||||
|
@ -419,7 +421,7 @@ CONST CHAR16 *
|
|||
This function allocates a buffer to store the file's information. It's the caller's
|
||||
responsibility to free the buffer.
|
||||
|
||||
@param[in] FileHandle A File Handle
|
||||
@param[in] FileHandle A File Handle.
|
||||
|
||||
@return !=NULL Cannot get the file info.
|
||||
@return NULL A pointer to a buffer with file information.
|
||||
|
@ -437,7 +439,7 @@ EFI_FILE_INFO *
|
|||
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.
|
||||
|
||||
@param[in] Path The pointer to the device path
|
||||
@param[in] Path The pointer to the device path
|
||||
|
||||
@return all The pointer of the null-terminated file path. The path
|
||||
is callee-allocated and should be freed by the caller.
|
||||
|
@ -449,14 +451,14 @@ CHAR16 *
|
|||
);
|
||||
|
||||
/**
|
||||
Gets a file's current 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.
|
||||
|
||||
@param[in] FileHandle The file handle on which to get the current position.
|
||||
@paramp[out] Position Byte position from the start of the file
|
||||
@paramp[out] Position Byte position from the start of the file.
|
||||
|
||||
@retval EFI_SUCCESS Data was accessed.
|
||||
@retval EFI_UNSUPPORTED The request is not valid on open directories.
|
||||
|
@ -508,7 +510,7 @@ EFI_STATUS
|
|||
@retval EFI_SUCCESS The help text was returned.
|
||||
@retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
|
||||
returned help text.
|
||||
@retval EFI_INVALID_PARAMETER HelpText is NULL
|
||||
@retval EFI_INVALID_PARAMETER HelpText is NULL.
|
||||
@retval EFI_NOT_FOUND There is no help text available for Command.
|
||||
**/
|
||||
typedef
|
||||
|
@ -538,7 +540,7 @@ EFI_STATUS
|
|||
portion of the device path after the mapping.
|
||||
|
||||
@retval NULL No mapping was found.
|
||||
@return !=NULL Pointer to null-terminated mapping. The buffer
|
||||
@retval !=NULL Pointer to null-terminated mapping. The buffer
|
||||
is callee allocated and should be freed by the caller.
|
||||
**/
|
||||
typedef
|
||||
|
@ -552,8 +554,8 @@ CONST CHAR16 *
|
|||
|
||||
User can use this function to determine current page break mode.
|
||||
|
||||
@retval TRUE The page break output mode is enabled
|
||||
@retval FALSE The page break output mode is disabled
|
||||
@retval TRUE The page break output mode is enabled.
|
||||
@retval FALSE The page break output mode is disabled.
|
||||
**/
|
||||
typedef
|
||||
BOOLEAN
|
||||
|
@ -648,7 +650,7 @@ EFI_STATUS
|
|||
@param[in,out] FileList Points to the start of a list of files opened.
|
||||
|
||||
@retval EFI_SUCCESS Create the file list successfully.
|
||||
@return Others Can't create the file list.
|
||||
@return Can't create the file list.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
|
@ -672,7 +674,7 @@ EFI_STATUS
|
|||
@retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
|
||||
could not be opened.
|
||||
@retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
|
||||
@retval EFI_DEVICE_ERROR The device had an error
|
||||
@retval EFI_DEVICE_ERROR The device had an error.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
|
@ -682,7 +684,7 @@ EFI_STATUS
|
|||
);
|
||||
|
||||
/**
|
||||
Opens the root directory of a device on a handle
|
||||
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.
|
||||
|
||||
|
@ -694,7 +696,7 @@ EFI_STATUS
|
|||
@retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
|
||||
could not be opened.
|
||||
@retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
|
||||
@retval EFI_DEVICE_ERROR The device had an error
|
||||
@retval EFI_DEVICE_ERROR The device had an error.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
|
@ -712,15 +714,15 @@ EFI_STATUS
|
|||
current position is increased by the number of bytes returned.
|
||||
If FileHandle is a directory, then an error is returned.
|
||||
|
||||
@param[in] FileHandle The opened file handle for read
|
||||
@param[in] FileHandle The opened file handle for read.
|
||||
@param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.
|
||||
@param[in,out] Buffer The buffer in which data is read.
|
||||
|
||||
@retval EFI_SUCCESS Data was read.
|
||||
@retval EFI_NO_MEDIA The device has no media
|
||||
@retval EFI_DEVICE_ERROR The device reported an error
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
|
||||
@retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required size
|
||||
@retval EFI_NO_MEDIA The device has no media.
|
||||
@retval EFI_DEVICE_ERROR The device reported an error.
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
|
||||
@retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required size.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
|
@ -733,8 +735,6 @@ EFI_STATUS
|
|||
/**
|
||||
Deletes the duplicate file names files in the given file list.
|
||||
|
||||
This function deletes the reduplicate files in the given file list.
|
||||
|
||||
@param[in] FileList A pointer to the first entry in the file list.
|
||||
|
||||
@retval EFI_SUCCESS Always success.
|
||||
|
@ -784,15 +784,15 @@ EFI_STATUS
|
|||
@param[in] Alias Points to the null-terminated shell alias.
|
||||
If this parameter is NULL, then all
|
||||
aliases will be returned in ReturnedData.
|
||||
@param[out] Volatile upon return of a single command if TRUE indicates
|
||||
@param[out] Volatile Upon return of a single command if TRUE indicates
|
||||
this is stored in a volatile fashion. FALSE otherwise.
|
||||
@return 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.
|
||||
@retval NULL an error ocurred
|
||||
@retval NULL Alias was not a valid Alias
|
||||
@retval NULL an error ocurred.
|
||||
@retval NULL Alias was not a valid Alias.
|
||||
**/
|
||||
typedef
|
||||
CONST CHAR16 *
|
||||
|
@ -866,8 +866,8 @@ EFI_STATUS
|
|||
|
||||
This function changes file information.
|
||||
|
||||
@param[in] FileHandle A file handle
|
||||
@param[in] FileInfo Points to new file information.
|
||||
@param[in] FileHandle A file handle
|
||||
@param[in] FileInfo Points to new file information.
|
||||
|
||||
@retval EFI_SUCCESS The information was set.
|
||||
@retval EFI_NO_MEDIA The device has no medium.
|
||||
|
@ -886,7 +886,7 @@ EFI_STATUS
|
|||
);
|
||||
|
||||
/**
|
||||
Sets a file's current 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
|
||||
|
@ -894,8 +894,8 @@ EFI_STATUS
|
|||
grow the file). Seeking to position 0xFFFFFFFFFFFFFFFF causes the current position
|
||||
to be set to the end of the file.
|
||||
|
||||
@param[in] FileHandle The file handle on which requested position will be set.
|
||||
@param[in] Position Byte position from the start of the file
|
||||
@param[in] FileHandle The file handle on which requested position will be set.
|
||||
@param[in] Position Byte position from the start of the file.
|
||||
|
||||
@retval EFI_SUCCESS Data was written.
|
||||
@retval EFI_UNSUPPORTED The seek request for nonzero is not valid on open directories.
|
||||
|
@ -910,9 +910,9 @@ EFI_STATUS
|
|||
/**
|
||||
This function creates a mapping for a device path.
|
||||
|
||||
@param[in] DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
|
||||
@param[in] DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
|
||||
then the mapping will be deleted.
|
||||
@param[in] Mapping Points to the null-terminated mapping for the device path.
|
||||
@param[in] Mapping Points to the null-terminated mapping for the device path.
|
||||
|
||||
@retval EFI_SUCCESS Mapping created or deleted successfully.
|
||||
@retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
|
||||
|
@ -941,14 +941,14 @@ EFI_STATUS
|
|||
@param[in,out] BufferSize On input, size of Buffer.
|
||||
@param[in] Buffer The buffer in which data to write.
|
||||
|
||||
@retval EFI_SUCCESS Data was written.
|
||||
@retval EFI_UNSUPPORTED Writes to open directory are not supported
|
||||
@retval EFI_NO_MEDIA The device has no media
|
||||
@retval EFI_DEVICE_ERROR The device reported an error
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
|
||||
@retval EFI_WRITE_PROTECTED The device is write-protected
|
||||
@retval EFI_ACCESS_DENIED The file was open for read only
|
||||
@retval EFI_VOLUME_FULL The volume is full
|
||||
@retval EFI_SUCCESS Data was written.
|
||||
@retval EFI_UNSUPPORTED Writes to open directory are not supported.
|
||||
@retval EFI_NO_MEDIA The device has no media.
|
||||
@retval EFI_DEVICE_ERROR The device reported an error.
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
|
||||
@retval EFI_WRITE_PROTECTED The device is write-protected.
|
||||
@retval EFI_ACCESS_DENIED The file was open for read only.
|
||||
@retval EFI_VOLUME_FULL The volume is full.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Defines for EFI shell environment 2 ported to EDK II build environment. (no spec)
|
||||
|
||||
Copyright (c) 2005 - 2009, Intel Corporation
|
||||
Copyright (c) 2005 - 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
@ -25,8 +25,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|||
|
||||
|
||||
/**
|
||||
this function is a prototype for a function that dumps information on a protocol
|
||||
to a given location. the location is dependant on the implementation. This is
|
||||
This function is a prototype for a function that dumps information on a protocol
|
||||
to a given location. The location is dependant on the implementation. This is
|
||||
used when programatically adding shell commands.
|
||||
|
||||
@param Handle the handle the protocol is on
|
||||
|
@ -41,15 +41,15 @@ VOID
|
|||
);
|
||||
|
||||
/**
|
||||
this function is a prototype foe each command internal to the EFI shell
|
||||
implementation. the specific command depends on the implementation. This is
|
||||
This function is a prototype for each command internal to the EFI shell
|
||||
implementation. The specific command depends on the implementation. This is
|
||||
used when programatically adding shell commands.
|
||||
|
||||
@param ImageHandle The handle to the binary shell
|
||||
@param SystemTable pointer to the system table.
|
||||
@param ImageHandle The handle to the binary shell.
|
||||
@param SystemTable Pointer to the system table.
|
||||
|
||||
@retval EFI_SUCCESS the command ran to completion
|
||||
@return other an error ocurred. any error is possible
|
||||
@retval EFI_SUCCESS The command ran to completion
|
||||
@retval other An error ocurred. Any error is possible
|
||||
depending on the implementation of the shell
|
||||
command.
|
||||
|
||||
|
@ -66,9 +66,9 @@ EFI_STATUS
|
|||
This is used when programatically adding shell commands. Upon successful return
|
||||
the memory allocated is up to the caller to free.
|
||||
|
||||
@param Str pointer to pointer to string to display for help.
|
||||
@param Str Pointer to pointer to string to display for help.
|
||||
|
||||
@retval EFI_SUCCESS the help string is in the parameter Str.
|
||||
@retval EFI_SUCCESS Phe help string is in the parameter Str.
|
||||
|
||||
**/
|
||||
typedef
|
||||
|
@ -78,26 +78,26 @@ EFI_STATUS
|
|||
);
|
||||
|
||||
/**
|
||||
* Structure returned from functions that open multiple files
|
||||
Structure returned from functions that open multiple files.
|
||||
**/
|
||||
typedef struct {
|
||||
UINT32 Signature; ///< SHELL_FILE_ARG_SIGNATURE
|
||||
LIST_ENTRY Link; ///< linked list helper
|
||||
LIST_ENTRY Link; ///< Linked list helper
|
||||
EFI_STATUS Status; ///< File's status
|
||||
|
||||
EFI_FILE_HANDLE Parent; ///< what is the Parent file of this file
|
||||
UINT64 OpenMode; ///< how was the file opened
|
||||
CHAR16 *ParentName; ///< string representation of parent
|
||||
EFI_FILE_HANDLE Parent; ///< What is the Parent file of this file
|
||||
UINT64 OpenMode; ///< How was the file opened
|
||||
CHAR16 *ParentName; ///< String representation of parent
|
||||
EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; ///< DevicePath for Parent
|
||||
|
||||
CHAR16 *FullName; ///< path and file name for this file
|
||||
CHAR16 *FileName; ///< file name for this file
|
||||
CHAR16 *FullName; ///< Path and file name for this file
|
||||
CHAR16 *FileName; ///< File name for this file
|
||||
|
||||
EFI_FILE_HANDLE Handle; ///< handle to this file
|
||||
EFI_FILE_INFO *Info; ///< pointer to file info for this file
|
||||
EFI_FILE_HANDLE Handle; ///< Handle to this file
|
||||
EFI_FILE_INFO *Info; ///< Pointer to file info for this file
|
||||
} SHELL_FILE_ARG;
|
||||
|
||||
/// signature for SHELL_FILE_ARG
|
||||
/// Signature for SHELL_FILE_ARG
|
||||
#define SHELL_FILE_ARG_SIGNATURE SIGNATURE_32 ('g', 'r', 'a', 'f')
|
||||
|
||||
/**
|
||||
|
@ -109,7 +109,7 @@ typedef struct {
|
|||
}
|
||||
|
||||
/**
|
||||
* GUID for the shell environment2 extension (main GUID same as shell environment)
|
||||
* GUID for the shell environment2 extension (main GUID same as shell environment).
|
||||
**/
|
||||
#define EFI_SE_EXT_SIGNATURE_GUID \
|
||||
{ \
|
||||
|
@ -120,19 +120,19 @@ typedef struct {
|
|||
#define EFI_SHELL_MINOR_VER 0x00000000 ///< Minor version of the EFI_SHELL_ENVIRONMENT2
|
||||
|
||||
/**
|
||||
execute a command line
|
||||
Execute a command line
|
||||
|
||||
this function will run the CommandLine. This includes loading any required images,
|
||||
This function will run the CommandLine. This includes loading any required images,
|
||||
parsing any requires scripts, and it DebugOutput is TRUE printing errors
|
||||
encountered directly to the screen.
|
||||
|
||||
@param ParentImageHandle Handle of image executing this operation
|
||||
@param CommandLine string command line to execute
|
||||
@param ParentImageHandle Handle of image executing this operation.
|
||||
@param CommandLine string command line to execute.
|
||||
@param DebugOutput TRUE indicates that errors should be printed directly.
|
||||
FALSE supresses error messages.
|
||||
|
||||
@retval EFI_SUCCESS the command line executed and completed.
|
||||
@retval EFI_ABORTED the operation did not complete due to abort.
|
||||
@retval EFI_SUCCESS The command line executed and completed.
|
||||
@retval EFI_ABORTED The operation did not complete due to abort.
|
||||
@retval EFI_INVALID_PARAMETER A parameter did not have a valid value.
|
||||
@retval EFI_OUT_OF_RESOURCES A required memory allocation failed.
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Provides interface to EFI_FILE_HANDLE functionality.
|
||||
|
||||
Copyright (c) 2006 - 2009, Intel Corporation
|
||||
Copyright (c) 2006 - 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Library used for sorting routines.
|
||||
|
||||
Copyright (c) 2009, Intel Corporation
|
||||
Copyright (c) 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Provides application point extension for "C" style main funciton
|
||||
|
||||
Copyright (c) 2009, Intel Corporation
|
||||
Copyright (c) 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Provides interface to shell functionality for shell commands and applications.
|
||||
|
||||
Copyright (c) 2006 - 2009, Intel Corporation
|
||||
Copyright (c) 2006 - 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Provides interface to shell functionality for shell commands and applications.
|
||||
|
||||
Copyright (c) 2006 - 2009, Intel Corporation
|
||||
Copyright (c) 2006 - 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Library used for sorting routines.
|
||||
|
||||
Copyright (c) 2009, Intel Corporation
|
||||
Copyright (c) 2009, Intel Corporation<BR>
|
||||
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
|
||||
|
|
Loading…
Reference in New Issue