diff options
author | jcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-11-18 21:36:50 +0000 |
---|---|---|
committer | jcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-11-18 21:36:50 +0000 |
commit | 125c2cf4f152760920ee4b1e5d73e03daf02d394 (patch) | |
tree | 3b8a0afb72470763e10cdfb68e6602df86fe981f /ShellPkg/Include/Protocol | |
parent | b594c4665866584649ee58cc8414cc1d5cd21e8d (diff) | |
download | edk2-platforms-125c2cf4f152760920ee4b1e5d73e03daf02d394.tar.xz |
updating headers from code review.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9449 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'ShellPkg/Include/Protocol')
-rw-r--r-- | ShellPkg/Include/Protocol/EfiShell.h | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/ShellPkg/Include/Protocol/EfiShell.h b/ShellPkg/Include/Protocol/EfiShell.h index 658f892f07..8b489dac6b 100644 --- a/ShellPkg/Include/Protocol/EfiShell.h +++ b/ShellPkg/Include/Protocol/EfiShell.h @@ -26,12 +26,12 @@ // replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.
// they are identical outside of the name.
typedef struct {
- LIST_ENTRY Link;
- EFI_STATUS Status;
- CONST CHAR16 *FullName;
- CONST CHAR16 *FileName;
- EFI_FILE_HANDLE Handle;
- EFI_FILE_INFO *Info;
+ 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.
@@ -85,7 +85,7 @@ EFI_STATUS @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 devide, or could not
+ @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
@@ -846,10 +846,10 @@ EFI_STATUS For a description of volatile and non-volatile environment variables, see UEFI Shell
2.0 specification section 3.6.1.
- @param[in] Name Points to the null-terminated environment variable name.
- @param[in] Value Points to the null-terminated environment variable value. If the value is an
+ @param[in] Name Points to the null-terminated environment variable name.
+ @param[in] Value Points to the null-terminated environment variable value. If the value is an
empty string then the environment variable is deleted.
- @param[in] Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
+ @param[in] Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
@retval EFI_SUCCESS The environment variable was successfully updated.
**/
|