/** @file\r
Defines for EFI shell environment 2 ported to EDK II build environment. (no spec)\r
\r
-Copyright (c) 2005 - 2009, Intel Corporation\r
+Copyright (c) 2005 - 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
\r
\r
/**\r
- this function is a prototype for a function that dumps information on a protocol \r
- to a given location. the location is dependant on the implementation. This is \r
+ This function is a prototype for a function that dumps information on a protocol \r
+ to a given location. The location is dependant on the implementation. This is \r
used when programatically adding shell commands.\r
\r
@param Handle the handle the protocol is on\r
);\r
\r
/**\r
- this function is a prototype foe each command internal to the EFI shell \r
- implementation. the specific command depends on the implementation. This is \r
+ This function is a prototype for each command internal to the EFI shell \r
+ implementation. The specific command depends on the implementation. This is \r
used when programatically adding shell commands.\r
\r
- @param ImageHandle The handle to the binary shell\r
- @param SystemTable pointer to the system table.\r
+ @param ImageHandle The handle to the binary shell.\r
+ @param SystemTable Pointer to the system table.\r
\r
- @retval EFI_SUCCESS the command ran to completion\r
- @return other an error ocurred. any error is possible \r
+ @retval EFI_SUCCESS The command ran to completion\r
+ @retval other An error ocurred. Any error is possible \r
depending on the implementation of the shell \r
command.\r
\r
This is used when programatically adding shell commands. Upon successful return \r
the memory allocated is up to the caller to free.\r
\r
- @param Str pointer to pointer to string to display for help.\r
+ @param Str Pointer to pointer to string to display for help.\r
\r
- @retval EFI_SUCCESS the help string is in the parameter Str.\r
+ @retval EFI_SUCCESS Phe help string is in the parameter Str.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
-* Structure returned from functions that open multiple files\r
+Structure returned from functions that open multiple files.\r
**/\r
typedef struct {\r
UINT32 Signature; ///< SHELL_FILE_ARG_SIGNATURE\r
- LIST_ENTRY Link; ///< linked list helper\r
+ LIST_ENTRY Link; ///< Linked list helper\r
EFI_STATUS Status; ///< File's status\r
\r
- EFI_FILE_HANDLE Parent; ///< what is the Parent file of this file\r
- UINT64 OpenMode; ///< how was the file opened\r
- CHAR16 *ParentName; ///< string representation of parent\r
+ EFI_FILE_HANDLE Parent; ///< What is the Parent file of this file\r
+ UINT64 OpenMode; ///< How was the file opened\r
+ CHAR16 *ParentName; ///< String representation of parent\r
EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; ///< DevicePath for Parent\r
\r
- CHAR16 *FullName; ///< path and file name for this file\r
- CHAR16 *FileName; ///< file name for this file\r
+ CHAR16 *FullName; ///< Path and file name for this file\r
+ CHAR16 *FileName; ///< File name for this file\r
\r
- EFI_FILE_HANDLE Handle; ///< handle to this file\r
- EFI_FILE_INFO *Info; ///< pointer to file info for this file\r
+ EFI_FILE_HANDLE Handle; ///< Handle to this file\r
+ EFI_FILE_INFO *Info; ///< Pointer to file info for this file\r
} SHELL_FILE_ARG;\r
\r
-/// signature for SHELL_FILE_ARG\r
+/// Signature for SHELL_FILE_ARG\r
#define SHELL_FILE_ARG_SIGNATURE SIGNATURE_32 ('g', 'r', 'a', 'f') \r
\r
/**\r
}\r
\r
/**\r
-* GUID for the shell environment2 extension (main GUID same as shell environment)\r
+* GUID for the shell environment2 extension (main GUID same as shell environment).\r
**/\r
#define EFI_SE_EXT_SIGNATURE_GUID \\r
{ \\r
#define EFI_SHELL_MINOR_VER 0x00000000 ///< Minor version of the EFI_SHELL_ENVIRONMENT2\r
\r
/**\r
- execute a command line\r
+ Execute a command line\r
\r
- this function will run the CommandLine. This includes loading any required images, \r
+ This function will run the CommandLine. This includes loading any required images, \r
parsing any requires scripts, and it DebugOutput is TRUE printing errors \r
encountered directly to the screen.\r
\r
- @param ParentImageHandle Handle of image executing this operation\r
- @param CommandLine string command line to execute\r
+ @param ParentImageHandle Handle of image executing this operation.\r
+ @param CommandLine string command line to execute.\r
@param DebugOutput TRUE indicates that errors should be printed directly.\r
FALSE supresses error messages.\r
\r
- @retval EFI_SUCCESS the command line executed and completed.\r
- @retval EFI_ABORTED the operation did not complete due to abort.\r
+ @retval EFI_SUCCESS The command line executed and completed.\r
+ @retval EFI_ABORTED The operation did not complete due to abort.\r
@retval EFI_INVALID_PARAMETER A parameter did not have a valid value.\r
@retval EFI_OUT_OF_RESOURCES A required memory allocation failed.\r
\r
projects / mirror_edk2.git / blobdiff