Return the system to the state it was before InstallConsoleLogger
was installed.
- @param[in,out] ConsoleInfo The object from the install function.
+ @param[in, out] ConsoleInfo The object from the install function.
@retval EFI_SUCCESS The operation was successful
@return other The operation failed. This was from UninstallProtocolInterface.
/**\r
ReadKeyStroke function for the fake simple text input.\r
\r
- @param[in] This A pointer to the SimpleTextIn structure.\r
- @param[in,out] Key A pointer to the Key structure to fill.\r
+ @param[in] This A pointer to the SimpleTextIn structure.\r
+ @param[in, out] Key A pointer to the Key structure to fill.\r
\r
@retval EFI_SUCCESS The read was successful.\r
**/\r
Move the cursor position one character backward.
@param[in] LineLength Length of a line. Get it by calling QueryMode
- @param[in,out] Column Current column of the cursor position
- @param[in,out] Row Current row of the cursor position
+ @param[in, out] Column Current column of the cursor position
+ @param[in, out] Row Current row of the cursor position
**/
VOID
EFIAPI
@param[in] LineLength Length of a line.
@param[in] TotalRow Total row of a screen
- @param[in,out] Column Current column of the cursor position
- @param[in,out] Row Current row of the cursor position
+ @param[in, out] Column Current column of the cursor position
+ @param[in, out] Row Current row of the cursor position
**/
VOID
EFIAPI
/**\r
File style interface for console (GetInfo).\r
\r
- @param[in] This Ignored.\r
- @param[in] InformationType Ignored.\r
- @param[in,out] BufferSize Ignored.\r
- @param[out] Buffer Ignored.\r
+ @param[in] This Ignored.\r
+ @param[in] InformationType Ignored.\r
+ @param[in, out] BufferSize Ignored.\r
+ @param[out] Buffer Ignored.\r
\r
@retval EFI_UNSUPPORTED\r
**/\r
\r
Writes data to the screen.\r
\r
- @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
- @param[in,out] BufferSize Size in bytes of Buffer.\r
- @param[in] Buffer The pointer to the buffer to write.\r
+ @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
+ @param[in, out] BufferSize Size in bytes of Buffer.\r
+ @param[in] Buffer The pointer to the buffer to write.\r
\r
@retval EFI_UNSUPPORTED No output console is supported.\r
@return A return value from gST->ConOut->OutputString.\r
/**\r
File style interface for StdIn (Write).\r
\r
- @param[in] This Ignored.\r
- @param[in,out] BufferSize Ignored.\r
- @param[in] Buffer Ignored.\r
+ @param[in] This Ignored.\r
+ @param[in, out] BufferSize Ignored.\r
+ @param[in] Buffer Ignored.\r
\r
@retval EFI_UNSUPPORTED\r
**/\r
\r
Writes error to the error output.\r
\r
- @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
- @param[in,out] BufferSize Size in bytes of Buffer.\r
- @param[in] Buffer The pointer to the buffer to write.\r
+ @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
+ @param[in, out] BufferSize Size in bytes of Buffer.\r
+ @param[in] Buffer The pointer to the buffer to write.\r
\r
@return A return value from gST->StdErr->OutputString.\r
**/\r
/**\r
File style interface for console StdOut (Read).\r
\r
- @param[in] This Ignored.\r
- @param[in,out] BufferSize Ignored.\r
- @param[out] Buffer Ignored.\r
+ @param[in] This Ignored.\r
+ @param[in, out] BufferSize Ignored.\r
+ @param[out] Buffer Ignored.\r
\r
@retval EFI_UNSUPPORTED\r
**/\r
/**\r
File style interface for console StdErr (Read).\r
\r
- @param[in] This Ignored.\r
- @param[in,out] BufferSize Ignored.\r
- @param[out] Buffer Ignored.\r
+ @param[in] This Ignored.\r
+ @param[in, out] BufferSize Ignored.\r
+ @param[out] Buffer Ignored.\r
\r
@retval EFI_UNSUPPORTED Always.\r
**/\r
/**\r
File style interface for NUL file (Read).\r
\r
- @param[in] This Ignored.\r
- @param[in,out] BufferSize Poiner to 0 upon return.\r
- @param[out] Buffer Ignored.\r
+ @param[in] This Ignored.\r
+ @param[in, out] BufferSize Poiner to 0 upon return.\r
+ @param[out] Buffer Ignored.\r
\r
@retval EFI_SUCCESS Always.\r
**/\r
/**\r
File style interface for NUL file (Write).\r
\r
- @param[in] This Ignored.\r
- @param[in,out] BufferSize Ignored.\r
- @param[in] Buffer Ignored.\r
+ @param[in] This Ignored.\r
+ @param[in, out] BufferSize Ignored.\r
+ @param[in] Buffer Ignored.\r
\r
@retval EFI_SUCCESS\r
**/\r
/**\r
File style interface for Environment Variable (Read).\r
\r
- @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
- @param[in,out] BufferSize Size in bytes of Buffer.\r
- @param[out] Buffer The pointer to the buffer to fill.\r
+ @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
+ @param[in, out] BufferSize Size in bytes of Buffer.\r
+ @param[out] Buffer The pointer to the buffer to fill.\r
\r
@retval EFI_SUCCESS The data was read.\r
**/\r
/**\r
File style interface for Volatile Environment Variable (Write).\r
\r
- @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
- @param[in,out] BufferSize Size in bytes of Buffer.\r
- @param[in] Buffer The pointer to the buffer to write.\r
+ @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
+ @param[in, out] BufferSize Size in bytes of Buffer.\r
+ @param[in] Buffer The pointer to the buffer to write.\r
\r
@retval EFI_SUCCESS The data was read.\r
**/\r
/**\r
File style interface for Non Volatile Environment Variable (Write).\r
\r
- @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
- @param[in,out] BufferSize Size in bytes of Buffer.\r
- @param[in] Buffer The pointer to the buffer to write.\r
+ @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
+ @param[in, out] BufferSize Size in bytes of Buffer.\r
+ @param[in] Buffer The pointer to the buffer to write.\r
\r
@retval EFI_SUCCESS The data was read.\r
**/\r
Move the cursor position one character backward.\r
\r
@param[in] LineLength Length of a line. Get it by calling QueryMode\r
- @param[in,out] Column Current column of the cursor position\r
- @param[in,out] Row Current row of the cursor position\r
+ @param[in, out] Column Current column of the cursor position\r
+ @param[in, out] Row Current row of the cursor position\r
**/\r
VOID\r
EFIAPI\r
\r
@param[in] LineLength Length of a line.\r
@param[in] TotalRow Total row of a screen\r
- @param[in,out] Column Current column of the cursor position\r
- @param[in,out] Row Current row of the cursor position\r
+ @param[in, out] Column Current column of the cursor position\r
+ @param[in, out] Row Current row of the cursor position\r
**/\r
VOID\r
EFIAPI\r
/**\r
File style interface for Mem (Write).\r
\r
- @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
- @param[in,out] BufferSize Size in bytes of Buffer.\r
- @param[in] Buffer The pointer to the buffer to write.\r
+ @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
+ @param[in, out] BufferSize Size in bytes of Buffer.\r
+ @param[in] Buffer The pointer to the buffer to write.\r
\r
@retval EFI_SUCCESS The data was written.\r
**/\r
/**\r
File style interface for Mem (Read).\r
\r
- @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
- @param[in,out] BufferSize Size in bytes of Buffer.\r
- @param[in] Buffer The pointer to the buffer to fill.\r
+ @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
+ @param[in, out] BufferSize Size in bytes of Buffer.\r
+ @param[in] Buffer The pointer to the buffer to fill.\r
\r
@retval EFI_SUCCESS The data was read.\r
**/\r
If the file was opened with ASCII mode the data will be processed through \r
AsciiSPrint before writing.\r
\r
- @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
- @param[in,out] BufferSize Size in bytes of Buffer.\r
- @param[in] Buffer The pointer to the buffer to write.\r
+ @param[in] This The pointer to the EFI_FILE_PROTOCOL object.\r
+ @param[in, out] BufferSize Size in bytes of Buffer.\r
+ @param[in] Buffer The pointer to the buffer to write.\r
\r
@retval EFI_SUCCESS The data was written.\r
**/\r
loaded image protocol installed on it. The FilePath will point to the device path\r
for the file that was loaded.\r
\r
- @param[in,out] DevPath On a sucessful return the device path to the loaded image.\r
- @param[in,out] FilePath On a sucessful return the device path to the file.\r
+ @param[in, out] DevPath On a sucessful return the device path to the loaded image.\r
+ @param[in, out] FilePath On a sucessful return the device path to the file.\r
\r
@retval EFI_SUCCESS The 2 device paths were sucessfully returned.\r
@retval other A error from gBS->HandleProtocol.\r
Checks if a string is an alias for another command. If yes, then it replaces the alias name\r
with the correct command name.\r
\r
- @param[in,out] CommandString Upon entry the potential alias. Upon return the\r
- command name if it was an alias. If it was not\r
- an alias it will be unchanged. This function may\r
- change the buffer to fit the command name.\r
+ @param[in, out] CommandString Upon entry the potential alias. Upon return the\r
+ command name if it was an alias. If it was not\r
+ an alias it will be unchanged. This function may\r
+ change the buffer to fit the command name.\r
\r
@retval EFI_SUCCESS The name was changed.\r
@retval EFI_SUCCESS The name was not an alias.\r
loaded image protocol installed on it. the FilePath will point to the device path\r
for the file that was loaded.\r
\r
- @param[in,out] DevPath on a sucessful return the device path to the loaded image\r
- @param[in,out] FilePath on a sucessful return the device path to the file\r
+ @param[in, out] DevPath on a sucessful return the device path to the loaded image\r
+ @param[in, out] FilePath on a sucessful return the device path to the file\r
\r
@retval EFI_SUCCESS the 2 device paths were sucessfully returned.\r
@return other a error from gBS->HandleProtocol\r
/**\r
Creates a list of all Shell-Guid-based environment variables.\r
\r
- @param[in,out] ListHead The pointer to pointer to LIST ENTRY object for\r
- storing this list.\r
+ @param[in, out] ListHead The pointer to pointer to LIST ENTRY object for\r
+ storing this list.\r
\r
@retval EFI_SUCCESS the list was created sucessfully.\r
**/\r
/**\r
Creates a list of all Shell-Guid-based environment variables.\r
\r
- @param[in,out] List The pointer to pointer to LIST_ENTRY object for\r
- storing this list.\r
+ @param[in, out] List The pointer to pointer to LIST_ENTRY object for\r
+ storing this list.\r
\r
@retval EFI_SUCCESS the list was created sucessfully.\r
**/\r
\r
Upon a sucessful return the caller is responsible to free the memory in *BriefDesc\r
\r
- @param[in] Handle FileHandle to read from\r
- @param[in] Command name of command's section to find\r
- @param[out] BriefDesc pointer to pointer to string where description goes.\r
- @param[out] BriefSize pointer to size of allocated BriefDesc\r
- @param[in,out] Ascii TRUE if the file is ASCII, FALSE otherwise, will be\r
- set if the file handle is at the 0 position.\r
+ @param[in] Handle FileHandle to read from\r
+ @param[in] Command name of command's section to find\r
+ @param[out] BriefDesc pointer to pointer to string where description goes.\r
+ @param[out] BriefSize pointer to size of allocated BriefDesc\r
+ @param[in, out] Ascii TRUE if the file is ASCII, FALSE otherwise, will be\r
+ set if the file handle is at the 0 position.\r
\r
@retval EFI_OUT_OF_RESOURCES a memory allocation failed.\r
@retval EFI_SUCCESS the section was found and its description sotred in\r
Temp Parameter must be large enough to hold the parameter before calling this\r
function.\r
\r
- @param[in,out] Walker pointer to string of command line. Adjusted to\r
+ @param[in, out] Walker pointer to string of command line. Adjusted to\r
reminaing command line on return\r
- @param[in,out] TempParameter pointer to string of command line item extracted.\r
+ @param[in, out] TempParameter pointer to string of command line item extracted.\r
\r
**/\r
VOID\r
parameters for inclusion in EFI_SHELL_PARAMETERS_PROTOCOL. this supports space\r
delimited and quote surrounded parameter definition.\r
\r
- @param[in] CommandLine String of command line to parse\r
- @param[in,out] Argv pointer to array of strings; one for each parameter\r
- @param[in,out] Argc pointer to number of strings in Argv array\r
+ @param[in] CommandLine String of command line to parse\r
+ @param[in, out] Argv pointer to array of strings; one for each parameter\r
+ @param[in, out] Argc pointer to number of strings in Argv array\r
\r
@return EFI_SUCCESS the operation was sucessful\r
@return EFI_OUT_OF_RESOURCES a memory allocation failed.\r
installs it on our handle and if there is an existing version of the protocol\r
that one is cached for removal later.\r
\r
- @param[in,out] NewShellParameters on a successful return, a pointer to pointer\r
+ @param[in, out] NewShellParameters on a successful return, a pointer to pointer\r
to the newly installed interface.\r
- @param[in,out] RootShellInstance on a successful return, pointer to boolean.\r
+ @param[in, out] RootShellInstance on a successful return, pointer to boolean.\r
TRUE if this is the root shell instance.\r
\r
@retval EFI_SUCCESS the operation completed successfully.\r
\r
All of the characters between quotes is replaced with spaces.\r
\r
- @param[in,out] TheString A pointer to the string to update.\r
+ @param[in, out] TheString A pointer to the string to update.\r
**/\r
VOID\r
EFIAPI\r
\r
This will also update the system table.\r
\r
- @param[in,out] ShellParameters Pointer to parameter structure to modify.\r
- @param[in] NewCommandLine The new command line to parse and use.\r
- @param[out] OldStdIn Pointer to old StdIn.\r
- @param[out] OldStdOut Pointer to old StdOut.\r
- @param[out] OldStdErr Pointer to old StdErr.\r
- @param[out] SystemTableInfo Pointer to old system table information.\r
+ @param[in, out] ShellParameters Pointer to parameter structure to modify.\r
+ @param[in] NewCommandLine The new command line to parse and use.\r
+ @param[out] OldStdIn Pointer to old StdIn.\r
+ @param[out] OldStdOut Pointer to old StdOut.\r
+ @param[out] OldStdErr Pointer to old StdErr.\r
+ @param[out] SystemTableInfo Pointer to old system table information.\r
\r
@retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid.\r
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
Funcion will replace the current StdIn and StdOut in the ShellParameters protocol\r
structure with StdIn and StdOut. The current values are de-allocated.\r
\r
- @param[in,out] ShellParameters Pointer to parameter structure to modify.\r
- @param[in] OldStdIn Pointer to old StdIn.\r
- @param[in] OldStdOut Pointer to old StdOut.\r
- @param[in] OldStdErr Pointer to old StdErr.\r
- @param[in] SystemTableInfo Pointer to old system table information.\r
+ @param[in, out] ShellParameters Pointer to parameter structure to modify.\r
+ @param[in] OldStdIn Pointer to old StdIn.\r
+ @param[in] OldStdOut Pointer to old StdOut.\r
+ @param[in] OldStdErr Pointer to old StdErr.\r
+ @param[in] SystemTableInfo Pointer to old system table information.\r
**/\r
EFI_STATUS\r
EFIAPI\r
\r
If OldArgv or OldArgc is NULL then that value is not returned.\r
\r
- @param[in,out] ShellParameters Pointer to parameter structure to modify.\r
- @param[in] NewCommandLine The new command line to parse and use.\r
- @param[out] OldArgv Pointer to old list of parameters.\r
- @param[out] OldArgc Pointer to old number of items in Argv list.\r
+ @param[in, out] ShellParameters Pointer to parameter structure to modify.\r
+ @param[in] NewCommandLine The new command line to parse and use.\r
+ @param[out] OldArgv Pointer to old list of parameters.\r
+ @param[out] OldArgc Pointer to old number of items in Argv list.\r
\r
@retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid.\r
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
structure with Argv and Argc. The current values are de-allocated and the\r
OldArgv must not be deallocated by the caller.\r
\r
- @param[in,out] ShellParameters pointer to parameter structure to modify\r
- @param[in] OldArgv pointer to old list of parameters\r
- @param[in] OldArgc pointer to old number of items in Argv list\r
+ @param[in, out] ShellParameters pointer to parameter structure to modify\r
+ @param[in] OldArgv pointer to old list of parameters\r
+ @param[in] OldArgc pointer to old number of items in Argv list\r
**/\r
VOID\r
EFIAPI\r
installs it on our handle and if there is an existing version of the protocol\r
that one is cached for removal later.\r
\r
- @param[in,out] NewShellParameters on a successful return, a pointer to pointer\r
+ @param[in, out] NewShellParameters on a successful return, a pointer to pointer\r
to the newly installed interface.\r
- @param[in,out] RootShellInstance on a successful return, pointer to boolean.\r
+ @param[in, out] RootShellInstance on a successful return, pointer to boolean.\r
TRUE if this is the root shell instance.\r
\r
@retval EFI_SUCCESS the operation completed successfully.\r
structure by parsing NewCommandLine. The current values are returned to the\r
user.\r
\r
- @param[in,out] ShellParameters pointer to parameter structure to modify\r
+ @param[in, out] ShellParameters pointer to parameter structure to modify\r
@param[in] NewCommandLine the new command line to parse and use\r
@param[out] OldArgv pointer to old list of parameters\r
@param[out] OldArgc pointer to old number of items in Argv list\r
structure with Argv and Argc. The current values are de-allocated and the\r
OldArgv must not be deallocated by the caller.\r
\r
- @param[in,out] ShellParameters pointer to parameter structure to modify\r
- @param[in] OldArgv pointer to old list of parameters\r
- @param[in] OldArgc pointer to old number of items in Argv list\r
+ @param[in, out] ShellParameters pointer to parameter structure to modify\r
+ @param[in] OldArgv pointer to old list of parameters\r
+ @param[in] OldArgc pointer to old number of items in Argv list\r
**/\r
VOID\r
EFIAPI\r
\r
This will also update the system table.\r
\r
- @param[in,out] ShellParameters Pointer to parameter structure to modify.\r
- @param[in] NewCommandLine The new command line to parse and use.\r
- @param[out] OldStdIn Pointer to old StdIn.\r
- @param[out] OldStdOut Pointer to old StdOut.\r
- @param[out] OldStdErr Pointer to old StdErr.\r
- @param[out] SystemTableInfo Pointer to old system table information.\r
+ @param[in, out] ShellParameters Pointer to parameter structure to modify.\r
+ @param[in] NewCommandLine The new command line to parse and use.\r
+ @param[out] OldStdIn Pointer to old StdIn.\r
+ @param[out] OldStdOut Pointer to old StdOut.\r
+ @param[out] OldStdErr Pointer to old StdErr.\r
+ @param[out] SystemTableInfo Pointer to old system table information.\r
\r
@retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid.\r
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
Funcion will replace the current StdIn and StdOut in the ShellParameters protocol\r
structure with StdIn and StdOut. The current values are de-allocated.\r
\r
- @param[in,out] ShellParameters Pointer to parameter structure to modify.\r
- @param[in] OldStdIn Pointer to old StdIn.\r
- @param[in] OldStdOut Pointer to old StdOut.\r
- @param[in] OldStdErr Pointer to old StdErr.\r
- @param[in] SystemTableInfo Pointer to old system table information.\r
+ @param[in, out] ShellParameters Pointer to parameter structure to modify.\r
+ @param[in] OldStdIn Pointer to old StdIn.\r
+ @param[in] OldStdOut Pointer to old StdOut.\r
+ @param[in] OldStdErr Pointer to old StdErr.\r
+ @param[in] SystemTableInfo Pointer to old system table information.\r
**/\r
EFI_STATUS\r
EFIAPI\r
parameters for inclusion in EFI_SHELL_PARAMETERS_PROTOCOL. this supports space\r
delimited and quote surrounded parameter definition.\r
\r
- @param[in] CommandLine String of command line to parse\r
- @param[in,out] Argv pointer to array of strings; one for each parameter\r
- @param[in,out] Argc pointer to number of strings in Argv array\r
+ @param[in] CommandLine String of command line to parse\r
+ @param[in, out] Argv pointer to array of strings; one for each parameter\r
+ @param[in, out] Argc pointer to number of strings in Argv array\r
\r
@return EFI_SUCCESS the operation was sucessful\r
@return EFI_OUT_OF_RESOURCES a memory allocation failed.\r
Temp Parameter must be large enough to hold the parameter before calling this\r
function.\r
\r
- @param[in,out] Walker pointer to string of command line. Adjusted to\r
+ @param[in, out] Walker pointer to string of command line. Adjusted to\r
reminaing command line on return\r
- @param[in,out] TempParameter pointer to string of command line item extracted.\r
+ @param[in, out] TempParameter pointer to string of command line item extracted.\r
\r
**/\r
VOID\r
/**\r
Updates a file name to be preceeded by the mapped drive name\r
\r
- @param[in] BasePath the Mapped drive name to prepend\r
- @param[in,out] Path pointer to pointer to the file name to update.\r
+ @param[in] BasePath the Mapped drive name to prepend\r
+ @param[in, out] Path pointer to pointer to the file name to update.\r
\r
@retval EFI_SUCCESS\r
@retval EFI_OUT_OF_RESOURCES\r
Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call\r
FreeFileList with FileList.\r
\r
- @param[in] FilePattern The FilePattern to check against.\r
- @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure\r
- @param[in] FileHandle The FileHandle to start with\r
- @param[in,out] FileList pointer to pointer to list of found files.\r
- @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.\r
- @param[in] MapName The file system name this file is on.\r
+ @param[in] FilePattern The FilePattern to check against.\r
+ @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure\r
+ @param[in] FileHandle The FileHandle to start with\r
+ @param[in, out] FileList pointer to pointer to list of found files.\r
+ @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.\r
+ @param[in] MapName The file system name this file is on.\r
\r
@retval EFI_SUCCESS all files were found and the FileList contains a list.\r
@retval EFI_NOT_FOUND no files were found\r
\r
This must be removed via calling CleanUpShellProtocol().\r
\r
- @param[in,out] NewShell The pointer to the pointer to the structure\r
+ @param[in, out] NewShell The pointer to the pointer to the structure\r
to install.\r
\r
@retval EFI_SUCCESS The operation was successful.\r
Free all memory and restore the system to the state it was in before calling\r
CreatePopulateInstallShellProtocol.\r
\r
- @param[in,out] NewShell The pointer to the new shell protocol structure.\r
+ @param[in, out] NewShell The pointer to the new shell protocol structure.\r
\r
@retval EFI_SUCCESS The operation was successful.\r
**/\r
\r
This must be removed via calling CleanUpShellProtocol().\r
\r
- @param[in,out] NewShell The pointer to the pointer to the structure \r
+ @param[in, out] NewShell The pointer to the pointer to the structure \r
to install.\r
\r
@retval EFI_SUCCESS The operation was successful.\r
Free all memory and restore the system to the state it was in before calling\r
CreatePopulateInstallShellProtocol.\r
\r
- @param[in,out] NewShell The pointer to the new shell protocol structure.\r
+ @param[in, out] NewShell The pointer to the new shell protocol structure.\r
\r
@retval EFI_SUCCESS The operation was successful.\r
**/\r
The ShellCEntryLib library instance wrappers the actual UEFI application\r
entry point and calls this ShellAppMain function.\r
\r
- @param ImageHandle The image handle of the UEFI Application.\r
- @param SystemTable A pointer to the EFI System Table.\r
+ @param Argc Argument count\r
+ @param Argv The parsed arguments\r
\r
@retval 0 The application exited normally.\r
@retval Other An error occurred.\r
are no more directory entries, the read returns a zero-length buffer.\r
EFI_FILE_INFO is the structure returned as the directory entry.\r
\r
- @param[in] FileHandle The opened file handle.\r
- @param[in,out] BufferSize On input, the size of buffer in bytes. On return,\r
- the number of bytes written.\r
- @param[out] Buffer The buffer to put read data into.\r
+ @param[in] FileHandle The opened file handle.\r
+ @param[in, out] BufferSize On input, the size of buffer in bytes. On return,\r
+ the number of bytes written.\r
+ @param[out] Buffer The buffer to put read data into.\r
\r
@retval EFI_SUCCESS Data was read.\r
@retval EFI_NO_MEDIA The device has no media.\r
The file is automatically grown to hold the data if required. Direct writes to\r
opened directories are not supported.\r
\r
- @param[in] FileHandle The opened file for writing.\r
- @param[in,out] BufferSize On input, the number of bytes in Buffer. On output,\r
- the number of bytes written.\r
- @param[in] Buffer The buffer containing data to write is stored.\r
+ @param[in] FileHandle The opened file for writing.\r
+ @param[in, out] BufferSize On input, the number of bytes in Buffer. On output,\r
+ the number of bytes written.\r
+ @param[in] Buffer The buffer containing data to write is stored.\r
\r
@retval EFI_SUCCESS Data was written.\r
@retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle FileHandle to read from.\r
- @param[in,out] Buffer The pointer to buffer to read into.\r
- @param[in,out] Size The pointer to number of bytes in Buffer.\r
- @param[in] Truncate If the buffer is large enough, this has no effect.\r
- If the buffer is is too small and Truncate is TRUE,\r
- the line will be truncated.\r
- If the buffer is is too small and Truncate is FALSE,\r
- then no read will occur.\r
+ @param[in] Handle FileHandle to read from.\r
+ @param[in, out] Buffer The pointer to buffer to read into.\r
+ @param[in, out] Size The pointer to number of bytes in Buffer.\r
+ @param[in] Truncate If the buffer is large enough, this has no effect.\r
+ If the buffer is is too small and Truncate is TRUE,\r
+ the line will be truncated.\r
+ If the buffer is is too small and Truncate is FALSE,\r
+ then no read will occur.\r
\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is\r
+ Ascii (TRUE) or UCS2 (FALSE).\r
\r
@retval EFI_SUCCESS The operation was successful. The line is stored in\r
Buffer.\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle FileHandle to read from.\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
+ @param[in] Handle FileHandle to read from.\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is\r
+ Ascii (TRUE) or UCS2 (FALSE).\r
\r
@return The line of text from the file.\r
\r
Removes the last directory or file entry in a path by changing the last\r
L'\' to a CHAR_NULL.\r
\r
- @param[in,out] Path The pointer to the path to modify.\r
+ @param[in, out] Path The pointer to the path to modify.\r
\r
@retval FALSE Nothing was found to remove.\r
@retval TRUE A directory or file was removed.\r
information is returned. If Sections is NULL, then all help text information\r
available is returned.\r
\r
- @param[in] CommandString The pointer to the command name. This is the name\r
- found on the command line in the shell.\r
- @param[in,out] RetVal The pointer to the return value from the command handler.\r
+ @param[in] CommandString The pointer to the command name. This is the name\r
+ found on the command line in the shell.\r
+ @param[in, out] RetVal The pointer to the return value from the command handler.\r
\r
- @param[in,out] CanAffectLE Indicates whether this command's return value\r
- needs to be placed into LASTERROR environment variable.\r
+ @param[in, out] CanAffectLE Indicates whether this command's return value\r
+ needs to be placed into LASTERROR environment variable.\r
\r
@retval RETURN_SUCCESS The handler was run.\r
@retval RETURN_NOT_FOUND The CommandString did not match a registered\r
This function opens a file with the open mode according to the file path. The\r
Attributes is valid only for EFI_FILE_MODE_CREATE.\r
\r
- @param[in,out] FilePath On input, the device path to the file. On output,\r
- the remaining device path.\r
- @param[out] DeviceHandle Pointer to the system device handle.\r
- @param[out] FileHandle Pointer to the file handle.\r
- @param[in] OpenMode The mode to open the file with.\r
- @param[in] Attributes The file's file attributes.\r
+ @param[in, out] FilePath On input, the device path to the file. On output,\r
+ the remaining device path.\r
+ @param[out] DeviceHandle Pointer to the system device handle.\r
+ @param[out] FileHandle Pointer to the file handle.\r
+ @param[in] OpenMode The mode to open the file with.\r
+ @param[in] Attributes The file's file attributes.\r
\r
@retval EFI_SUCCESS The information was set.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
are no more directory entries, the read returns a zero-length buffer.\r
EFI_FILE_INFO is the structure returned as the directory entry.\r
\r
- @param[in] FileHandle The opened file handle.\r
- @param[in,out] ReadSize On input the size of buffer in bytes. On return\r
- the number of bytes written.\r
- @param[out] Buffer The buffer to put read data into.\r
+ @param[in] FileHandle The opened file handle.\r
+ @param[in, out] ReadSize On input the size of buffer in bytes. On return\r
+ the number of bytes written.\r
+ @param[out] Buffer The buffer to put read data into.\r
\r
@retval EFI_SUCCESS Data was read.\r
@retval EFI_NO_MEDIA The device has no media.\r
The file is automatically grown to hold the data if required. Direct writes to\r
opened directories are not supported.\r
\r
- @param[in] FileHandle The opened file for writing.\r
+ @param[in] FileHandle The opened file for writing.\r
\r
- @param[in,out] BufferSize On input the number of bytes in Buffer. On output\r
- the number of bytes written.\r
+ @param[in, out] BufferSize On input the number of bytes in Buffer. On output\r
+ the number of bytes written.\r
\r
- @param[in] Buffer The buffer containing data to write is stored.\r
+ @param[in] Buffer The buffer containing data to write is stored.\r
\r
@retval EFI_SUCCESS Data was written.\r
@retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r
call of this function has no file to get. *NoFile will be set to TRUE, and the\r
data in Buffer is meaningless.\r
\r
- @param[in] DirHandle The file handle of the directory.\r
- @param[in,out] Buffer The pointer to buffer for file's information.\r
- @param[in,out] NoFile The pointer to boolean when last file is found.\r
+ @param[in] DirHandle The file handle of the directory.\r
+ @param[in, out] Buffer The pointer to buffer for file's information.\r
+ @param[in, out] NoFile The pointer to boolean when last file is found.\r
\r
@retval EFI_SUCCESS Found the next file.\r
@retval EFI_NO_MEDIA The device has no media.\r
If you are NOT appending to an existing list *ListHead must be NULL. If\r
*ListHead is NULL then it must be callee freed.\r
\r
- @param[in] Arg The pointer to path string.\r
- @param[in] OpenMode Mode to open files with.\r
- @param[in,out] ListHead Head of linked list of results.\r
+ @param[in] Arg The pointer to path string.\r
+ @param[in] OpenMode Mode to open files with.\r
+ @param[in, out] ListHead Head of linked list of results.\r
\r
@retval EFI_SUCCESS The operation was sucessful and the list head\r
contains the list of opened files.\r
/**\r
Free the linked list returned from ShellOpenFileMetaArg.\r
\r
- @param[in,out] ListHead The pointer to free.\r
+ @param[in, out] ListHead The pointer to free.\r
\r
@retval EFI_SUCCESS The operation was sucessful.\r
@retval EFI_INVALID_PARAMETER A parameter was invalid.\r
If Destination's current length (including NULL terminator) is already more than\r
CurrentSize, then ASSERT().\r
\r
- @param[in,out] Destination The String to append onto.\r
- @param[in,out] CurrentSize On call, the number of bytes in Destination. On\r
- return, possibly the new size (still in bytes). If NULL,\r
- then allocate whatever is needed.\r
- @param[in] Source The String to append from.\r
- @param[in] Count The maximum number of characters to append. If 0, then\r
- all are appended.\r
+ @param[in, out] Destination The String to append onto.\r
+ @param[in, out] CurrentSize On call, the number of bytes in Destination. On\r
+ return, possibly the new size (still in bytes). If NULL,\r
+ then allocate whatever is needed.\r
+ @param[in] Source The String to append from.\r
+ @param[in] Count The maximum number of characters to append. If 0, then\r
+ all are appended.\r
\r
@return The Destination after appending the Source.\r
**/\r
\r
If the string would grow bigger than NewSize it will halt and return error.\r
\r
- @param[in] SourceString The string with source buffer.\r
- @param[in,out] NewString The string with resultant buffer.\r
- @param[in] NewSize The size in bytes of NewString.\r
- @param[in] FindTarget The string to look for.\r
- @param[in] ReplaceWith The string to replace FindTarget with.\r
- @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r
- immediately before it.\r
- @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r
+ @param[in] SourceString The string with source buffer.\r
+ @param[in, out] NewString The string with resultant buffer.\r
+ @param[in] NewSize The size in bytes of NewString.\r
+ @param[in] FindTarget The string to look for.\r
+ @param[in] ReplaceWith The string to replace FindTarget with.\r
+ @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r
+ immediately before it.\r
+ @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r
\r
@retval EFI_INVALID_PARAMETER SourceString was NULL.\r
@retval EFI_INVALID_PARAMETER NewString was NULL.\r
\r
@param[in] Type What type of question is asked. This is used to filter the input\r
to prevent invalid answers to question.\r
- @param[in] HiiFormatStringId The format string Id for getting from Hii.\r
- @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r
- @param[in,out] Response The pointer to Response, which will be populated upon return.\r
+ @param[in] HiiFormatStringId The format string Id for getting from Hii.\r
+ @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r
+ @param[in, out] Response The pointer to Response, which will be populated upon return.\r
\r
@retval EFI_SUCCESS The operation was sucessful.\r
@return other The operation failed.\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle SHELL_FILE_HANDLE to read from.\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
+ @param[in] Handle SHELL_FILE_HANDLE to read from.\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is\r
+ Ascii (TRUE) or UCS2 (FALSE).\r
\r
- @return The line of text from the file.\r
+ @return The line of text from the file.\r
\r
@sa ShellFileHandleReadLine\r
**/\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle SHELL_FILE_HANDLE to read from.\r
- @param[in,out] Buffer The pointer to buffer to read into.\r
- @param[in,out] Size The pointer to number of bytes in Buffer.\r
- @param[in] Truncate If the buffer is large enough, this has no effect.\r
- If the buffer is is too small and Truncate is TRUE,\r
- the line will be truncated.\r
- If the buffer is is too small and Truncate is FALSE,\r
- then no read will occur.\r
-\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
+ @param[in] Handle SHELL_FILE_HANDLE to read from.\r
+ @param[in, out] Buffer The pointer to buffer to read into.\r
+ @param[in, out] Size The pointer to number of bytes in Buffer.\r
+ @param[in] Truncate If the buffer is large enough, this has no effect.\r
+ If the buffer is is too small and Truncate is TRUE,\r
+ the line will be truncated.\r
+ If the buffer is is too small and Truncate is FALSE,\r
+ then no read will occur.\r
+\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is\r
+ Ascii (TRUE) or UCS2 (FALSE).\r
\r
@retval EFI_SUCCESS The operation was successful. The line is stored in\r
Buffer.\r
If Count is < 2 , then perform no action.\r
If Size is < 1 , then perform no action.\r
\r
- @param[in,out] BufferToSort On call, a Buffer of (possibly sorted) elements;\r
- on return, a buffer of sorted elements.\r
- @param[in] Count The number of elements in the buffer to sort.\r
- @param[in] ElementSize The size of an element in bytes.\r
- @param[in] CompareFunction The function to call to perform the comparison\r
- of any two elements.\r
+ @param[in, out] BufferToSort On call, a Buffer of (possibly sorted) elements;\r
+ on return, a buffer of sorted elements.\r
+ @param[in] Count The number of elements in the buffer to sort.\r
+ @param[in] ElementSize The size of an element in bytes.\r
+ @param[in] CompareFunction The function to call to perform the comparison\r
+ of any two elements.\r
**/\r
VOID\r
EFIAPI\r
If there are multiple map names they will be semi-colon seperated in the\r
NULL-terminated string.\r
\r
- @param[in,out] DevicePath On entry, points to a device path pointer. On\r
- exit, updates the pointer to point to the\r
- portion of the device path after the mapping.\r
+ @param[in, out] DevicePath On entry, points to a device path pointer. On\r
+ exit, updates the pointer to point to the\r
+ portion of the device path after the mapping.\r
\r
@retval NULL No mapping was found.\r
@retval !=NULL Pointer to NULL-terminated mapping. The buffer\r
according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each\r
matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.\r
\r
- @param[in] Path A pointer to the path string.\r
- @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or\r
- EFI_FILE_MODE_WRITE.\r
- @param[in,out] FileList Points to the start of a list of files opened.\r
+ @param[in] Path A pointer to the path string.\r
+ @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or\r
+ EFI_FILE_MODE_WRITE.\r
+ @param[in, out] FileList Points to the start of a list of files opened.\r
\r
@retval EFI_SUCCESS Create the file list successfully.\r
@return Can't create the file list.\r
current position is increased by the number of bytes returned.\r
If FileHandle is a directory, then an error is returned.\r
\r
- @param[in] FileHandle The opened file handle for read.\r
- @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.\r
- @param[in,out] Buffer The buffer in which data is read.\r
+ @param[in] FileHandle The opened file handle for read.\r
+ @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.\r
+ @param[in, out] Buffer The buffer in which data is read.\r
\r
@retval EFI_SUCCESS Data was read.\r
@retval EFI_NO_MEDIA The device has no media.\r
\r
Direct writes to opened directories are not supported.\r
\r
- @param[in] FileHandle The opened file handle for writing.\r
- @param[in,out] BufferSize On input, size of Buffer.\r
- @param[in] Buffer The buffer in which data to write.\r
+ @param[in] FileHandle The opened file handle for writing.\r
+ @param[in, out] BufferSize On input, size of Buffer.\r
+ @param[in] Buffer The buffer in which data to write.\r
\r
@retval EFI_SUCCESS Data was written.\r
@retval EFI_UNSUPPORTED Writes to open directory are not supported.\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[in,out] Str Pointer to pointer to string to display for help.\r
+ @param[in, out] Str Pointer to pointer to string to display for help.\r
\r
@retval EFI_SUCCESS The help string is in the parameter Str.\r
\r
The memory allocated by the callee for this list is freed by making a call to\r
SHELLENV_FREE_FILE_LIST.\r
\r
- @param[in] Arg The pointer Path to files to open.\r
- @param[in,out] ListHead The pointer to the allocated and initialized list head\r
- upon which to append all opened file structures.\r
+ @param[in] Arg The pointer Path to files to open.\r
+ @param[in, out] ListHead The pointer to the allocated and initialized list head\r
+ upon which to append all opened file structures.\r
\r
@retval EFI_SUCCESS One or more files was opened and a struct of each file's\r
information was appended to ListHead.\r
/**\r
This frees all of the nodes under the ListHead, but not ListHead itself.\r
\r
- @param[in,out] ListHead Pointer to list to free all nodes of.\r
+ @param[in, out] ListHead Pointer to list to free all nodes of.\r
\r
@retval EFI_SUCCESS This function always returns EFI_SUCCESS.\r
**/\r
This is an internal shell function to handle shell cascading. It restores the\r
original set of console protocols.\r
\r
- @param[in] ConInHandle The handle of ConIn.\r
- @param[in,out] ConIn The pointer to the location to return the pointer to\r
- the original console input.\r
- @param[in] ConOutHandle The handle of ConOut\r
- @param[in,out] ConOut The pointer to the location to return the pointer to\r
- the original console output.\r
+ @param[in] ConInHandle The handle of ConIn.\r
+ @param[in, out] ConIn The pointer to the location to return the pointer to\r
+ the original console input.\r
+ @param[in] ConOutHandle The handle of ConOut\r
+ @param[in, out] ConOut The pointer to the location to return the pointer to\r
+ the original console output.\r
**/\r
typedef\r
VOID\r
\r
This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.\r
\r
- @param[in,out] Handle The pointer to pointer to Handle. It is set\r
- on a sucessful return.\r
+ @param[in, out] Handle The pointer to pointer to Handle. It is set\r
+ on a sucessful return.\r
\r
@retval EFI_SUCCESS The next handle in the handle database is *Handle.\r
@retval EFI_NOT_FOUND There is not another handle.\r
This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be\r
called after INIT_PROTOCOL_INFO_ENUMERATOR.\r
\r
- @param[in,out] ProtocolInfo The pointer to pointer to protocol information structure.\r
+ @param[in, out] ProtocolInfo The pointer to pointer to protocol information structure.\r
\r
@retval EFI_SUCCESS The next protocol's information was sucessfully returned.\r
@retval NULL There are no more protocols.\r
\r
Upon successful return, the memory for *BestDeviceName is up to the caller to free.\r
\r
- @param[in] DeviceHandle The device handle whose name is desired.\r
- @param[in] UseComponentName Whether to use the ComponentName protocol at all.\r
- @param[in] UseDevicePath Whether to use the DevicePath protocol at all.\r
- @param[in] Language The pointer to the language string to use.\r
- @param[in,out] BestDeviceName The pointer to pointer to string allocated with the name.\r
- @param[out] ConfigurationStatus The pointer to status for opening a Configuration protocol.\r
- @param[out] DiagnosticsStatus The pointer to status for opening a Diagnostics protocol.\r
- @param[in] Display Whether to Print this out to default Print location.\r
- @param[in] Indent How many characters to indent the printing.\r
+ @param[in] DeviceHandle The device handle whose name is desired.\r
+ @param[in] UseComponentName Whether to use the ComponentName protocol at all.\r
+ @param[in] UseDevicePath Whether to use the DevicePath protocol at all.\r
+ @param[in] Language The pointer to the language string to use.\r
+ @param[in, out] BestDeviceName The pointer to pointer to string allocated with the name.\r
+ @param[out] ConfigurationStatus The pointer to status for opening a Configuration protocol.\r
+ @param[out] DiagnosticsStatus The pointer to status for opening a Diagnostics protocol.\r
+ @param[in] Display Whether to Print this out to default Print location.\r
+ @param[in] Indent How many characters to indent the printing.\r
\r
@retval EFI_SUCCESS This function always returns EFI_SUCCESS.\r
**/\r
The memory allocated by the callee for this list is freed by making a call to\r
SHELLENV_FREE_FILE_LIST.\r
\r
- @param[in] Arg The pointer to the path of the files to be opened.\r
- @param[in,out] ListHead The pointer to allocated and initialized list head\r
- upon which to append all the opened file structures.\r
+ @param[in] Arg The pointer to the path of the files to be opened.\r
+ @param[in, out] ListHead The pointer to allocated and initialized list head\r
+ upon which to append all the opened file structures.\r
\r
@retval EFI_SUCCESS One or more files was opened and a struct of each file's\r
information was appended to ListHead.\r
Removes the last directory or file entry in a path by changing the last\r
L'\' to a CHAR_NULL.\r
\r
- @param[in,out] Path The pointer to the path to modify.\r
+ @param[in, out] Path The pointer to the path to modify.\r
\r
@retval FALSE Nothing was found to remove.\r
@retval TRUE A directory or file was removed.\r
if Count is < 2 then perform no action.\r
if Size is < 1 then perform no action.\r
\r
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements\r
- on return a buffer of sorted elements\r
- @param[in] Count the number of elements in the buffer to sort\r
- @param[in] ElementSize Size of an element in bytes\r
- @param[in] CompareFunction The function to call to perform the comparison\r
- of any 2 elements\r
- @param[in] Buffer Buffer of size ElementSize for use in swapping\r
+ @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements\r
+ on return a buffer of sorted elements\r
+ @param[in] Count the number of elements in the buffer to sort\r
+ @param[in] ElementSize Size of an element in bytes\r
+ @param[in] CompareFunction The function to call to perform the comparison\r
+ of any 2 elements\r
+ @param[in] Buffer Buffer of size ElementSize for use in swapping\r
**/\r
VOID\r
EFIAPI\r
if Count is < 2 then perform no action.\r
if Size is < 1 then perform no action.\r
\r
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements\r
- on return a buffer of sorted elements\r
- @param[in] Count the number of elements in the buffer to sort\r
- @param[in] ElementSize Size of an element in bytes\r
- @param[in] CompareFunction The function to call to perform the comparison\r
- of any 2 elements\r
+ @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements\r
+ on return a buffer of sorted elements\r
+ @param[in] Count the number of elements in the buffer to sort\r
+ @param[in] ElementSize Size of an element in bytes\r
+ @param[in] CompareFunction The function to call to perform the comparison\r
+ of any 2 elements\r
**/\r
VOID\r
EFIAPI\r
if Destination's current length (including NULL terminator) is already more then\r
CurrentSize, then ASSERT()\r
\r
- @param[in,out] Destination The String to append onto\r
- @param[in,out] CurrentSize on call the number of bytes in Destination. On\r
+ @param[in, out] Destination The String to append onto\r
+ @param[in, out] CurrentSize on call the number of bytes in Destination. On\r
return possibly the new size (still in bytes). if NULL\r
then allocate whatever is needed.\r
@param[in] Source The String to append from\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle FileHandle to read from.\r
- @param[in,out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);\r
+ @param[in] Handle FileHandle to read from.\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);\r
\r
@return The line of text from the file.\r
\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle FileHandle to read from\r
- @param[in,out] Buffer pointer to buffer to read into\r
- @param[in,out] Size pointer to number of bytes in buffer\r
- @param[in] Truncate if TRUE then allows for truncation of the line to fit.\r
- if FALSE will reset the position to the begining of the\r
- line if the buffer is not large enough.\r
- @param[in,out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);\r
+ @param[in] Handle FileHandle to read from\r
+ @param[in, out] Buffer pointer to buffer to read into\r
+ @param[in, out] Size pointer to number of bytes in buffer\r
+ @param[in] Truncate if TRUE then allows for truncation of the line to fit.\r
+ if FALSE will reset the position to the begining of the\r
+ line if the buffer is not large enough.\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);\r
\r
@retval EFI_SUCCESS the operation was sucessful. the line is stored in\r
Buffer.\r
\r
If DestinationBuffer is NULL, then ASSERT().\r
\r
- @param[in,out] DestinationBuffer The pointer to the pointer to the buffer to append onto.\r
- @param[in,out] DestinationSize The pointer to the size of DestinationBuffer.\r
- @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.\r
- @param[in] SourceSize The number of bytes of SourceBuffer to append.\r
+ @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.\r
+ @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.\r
+ @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.\r
+ @param[in] SourceSize The number of bytes of SourceBuffer to append.\r
\r
@retval NULL A memory allocation failed.\r
@retval NULL A parameter was invalid.\r
/**\r
Function to append a 64 bit number / 25 onto the string.\r
\r
- @param[in,out] Str The string so append onto.\r
- @param[in] Num The number to divide and append.\r
+ @param[in, out] Str The string so append onto.\r
+ @param[in] Num The number to divide and append.\r
\r
@retval EFI_INVALID_PARAMETER A parameter was NULL.\r
@retval EFI_SUCCESS The appending was successful.\r
/**\r
Function to append a 64 bit number onto the mapping info.\r
\r
- @param[in,out] MappingItem The mapping info object to append onto.\r
- @param[in] Num The info to append.\r
+ @param[in, out] MappingItem The mapping info object to append onto.\r
+ @param[in] Num The info to append.\r
\r
@retval EFI_INVALID_PARAMETER A parameter was NULL.\r
@retval EFI_SUCCESS The appending was successful.\r
/**\r
Function to append string into the mapping info.\r
\r
- @param[in,out] MappingItem The mapping info object to append onto.\r
- @param[in] Str The info to append.\r
+ @param[in, out] MappingItem The mapping info object to append onto.\r
+ @param[in] Str The info to append.\r
\r
@retval EFI_INVALID_PARAMETER A parameter was NULL.\r
@retval EFI_SUCCESS The appending was successful.\r
/**\r
Function to append a Guid to the mapping item.\r
\r
- @param[in,out] MappingItem The item to append onto.\r
- @param[in] Guid The guid to append.\r
+ @param[in, out] MappingItem The item to append onto.\r
+ @param[in] Guid The guid to append.\r
\r
@retval EFI_SUCCESS The appending operation was successful.\r
@retval EFI_INVALID_PARAMETER A parameter was NULL.\r
information will be returned. If Sections is NULL, then all help text information\r
available will be returned.\r
\r
- @param[in] CommandString Pointer to the command name. This is the name\r
- found on the command line in the shell.\r
- @param[in,out] RetVal Pointer to the return vaule from the command handler.\r
+ @param[in] CommandString Pointer to the command name. This is the name\r
+ found on the command line in the shell.\r
+ @param[in, out] RetVal Pointer to the return vaule from the command handler.\r
\r
- @param[in,out] CanAffectLE indicates whether this command's return value\r
- needs to be placed into LASTERROR environment variable.\r
+ @param[in, out] CanAffectLE indicates whether this command's return value\r
+ needs to be placed into LASTERROR environment variable.\r
\r
@retval RETURN_SUCCESS The handler was run.\r
@retval RETURN_NOT_FOUND The CommandString did not match a registered\r
\r
/**\r
This function will populate the device path protocol parameter based on TheHandle.\r
- \r
- @param[in,out] DevPath On a sucessful return the device path to the handle.\r
+\r
+ @param[in] TheHandle Driver handle.\r
+ @param[in, out] FilePath On a sucessful return the device path to the handle.\r
\r
@retval EFI_SUCCESS The device path was sucessfully returned.\r
@retval other A error from gBS->HandleProtocol.\r
/**\r
The compression routine.\r
\r
- @param[in] SrcBuffer The buffer containing the source data.\r
- @param[in] SrcSize The number of bytes in SrcBuffer.\r
- @param[in] DstBuffer The buffer to put the compressed image in.\r
- @param[in,out] DstSize On input the size (in bytes) of DstBuffer, on\r
+ @param[in] SrcBuffer The buffer containing the source data.\r
+ @param[in] SrcSize The number of bytes in SrcBuffer.\r
+ @param[in] DstBuffer The buffer to put the compressed image in.\r
+ @param[in, out] DstSize On input the size (in bytes) of DstBuffer, on\r
return the number of bytes placed in DstBuffer.\r
\r
@retval EFI_SUCCESS The compression was sucessful.\r
/**\r
The compression routine.\r
\r
- @param[in] SrcBuffer The buffer containing the source data.\r
- @param[in] SrcSize Number of bytes in SrcBuffer.\r
- @param[in] DstBuffer The buffer to put the compressed image in.\r
- @param[in,out] DstSize On input the size (in bytes) of DstBuffer, on\r
- return the number of bytes placed in DstBuffer.\r
+ @param[in] SrcBuffer The buffer containing the source data.\r
+ @param[in] SrcSize Number of bytes in SrcBuffer.\r
+ @param[in] DstBuffer The buffer to put the compressed image in.\r
+ @param[in, out] DstSize On input the size (in bytes) of DstBuffer, on\r
+ return the number of bytes placed in DstBuffer.\r
\r
@retval EFI_SUCCESS The compression was sucessful.\r
@retval EFI_BUFFER_TOO_SMALL The buffer was too small. DstSize is required.\r
/**\r
Delete a char in line\r
\r
- @param[in,out] Line The line to delete in.\r
- @param[in] Pos Position to delete the char at ( start from 0 ).\r
+ @param[in, out] Line The line to delete in.\r
+ @param[in] Pos Position to delete the char at ( start from 0 ).\r
**/\r
VOID\r
EFIAPI\r
/**\r
Concatenate Src into Dest.\r
\r
- @param[in,out] Dest Destination string\r
- @param[in] Src Src String.\r
+ @param[in, out] Dest Destination string\r
+ @param[in] Src Src String.\r
**/\r
VOID\r
EFIAPI\r
//\r
// found\r
//\r
- if (Found == TRUE) {\r
+ if (Found) {\r
Column = (Position - 1) + FileBuffer.FilePosition.Column + Offset;\r
Row = FileBuffer.FilePosition.Row;\r
} else {\r
Found = TRUE;\r
} \r
\r
- if (Found == TRUE) {\r
+ if (Found) {\r
//\r
// found\r
//\r
VOID\r
)\r
{\r
- INT32 CurrentLine=0;\r
+ INT32 CurrentLine;\r
CHAR16 * InfoString;\r
EFI_INPUT_KEY Key;\r
- \r
+\r
+ CurrentLine = 0;\r
// print helpInfo \r
for (CurrentLine = 0; 0 != HexMainMenuHelpInfo[CurrentLine]; CurrentLine++) {\r
InfoString = HiiGetString(gShellDebug1HiiHandle, HexMainMenuHelpInfo[CurrentLine]\r
/**\r
Empty function. always returns the same.\r
\r
- @param[in] This Ignored.\r
- @param[in] Width Ignored.\r
- @param[in] Address Ignored.\r
- @param[in] Count Ignored.\r
- @param[in,out] Buffer Ignored.\r
+ @param[in] This Ignored.\r
+ @param[in] Width Ignored.\r
+ @param[in] Address Ignored.\r
+ @param[in] Count Ignored.\r
+ @param[in, out] Buffer Ignored.\r
\r
@retval EFI_UNSUPPORTED.\r
**/\r
/**\r
Empty function. always returns the same.\r
\r
- @param[in] This Ignored.\r
- @param[in] Width Ignored.\r
- @param[in] Address Ignored.\r
- @param[in] Count Ignored.\r
- @param[in,out] Buffer Ignored.\r
+ @param[in] This Ignored.\r
+ @param[in] Width Ignored.\r
+ @param[in] Address Ignored.\r
+ @param[in] Count Ignored.\r
+ @param[in, out] Buffer Ignored.\r
\r
@retval EFI_UNSUPPORTED.\r
**/\r
bits 23:16 - Base Class Code\r
bits 15:8 - Sub-Class Code\r
bits 7:0 - Programming Interface\r
- @param[in,out] ClassStrings Pointer of PCI_CLASS_STRINGS structure, which contains\r
+ @param[in, out] ClassStrings Pointer of PCI_CLASS_STRINGS structure, which contains\r
printable class strings corresponding to ClassCode. The\r
caller must not modify the strings that are pointed by\r
the fields in ClassStrings.\r
It also moves the pointer backward a node, to get prepared to be called\r
again.\r
\r
- @param[in,out] Descriptors Points to current position of a serial of address space\r
- descriptors.\r
- @param[out] MinBus The lower range of bus number.\r
- @param[out] ManBus The upper range of bus number.\r
- @param[out] IsEnd Meet end of the serial of descriptors.\r
+ @param[in, out] Descriptors Points to current position of a serial of address space\r
+ descriptors.\r
+ @param[out] MinBus The lower range of bus number.\r
+ @param[out] MaxBus The upper range of bus number.\r
+ @param[out] IsEnd Meet end of the serial of descriptors.\r
\r
@retval EFI_SUCCESS The command completed successfully.\r
**/\r
/**\r
Explain the Base Address Register(Bar) in PCI configuration space.\r
\r
- @param[in] Bar Points to the Base Address Register intended to interpret.\r
- @param[in] Command Points to the register Command.\r
- @param[in] Address Address used to access configuration space of this PCI device.\r
- @param[in] IoDev Handle used to access configuration space of PCI device.\r
- @param[in,out] Index The Index.\r
+ @param[in] Bar Points to the Base Address Register intended to interpret.\r
+ @param[in] Command Points to the register Command.\r
+ @param[in] Address Address used to access configuration space of this PCI device.\r
+ @param[in] IoDev Handle used to access configuration space of PCI device.\r
+ @param[in, out] Index The Index.\r
\r
@retval EFI_SUCCESS The command completed successfully.\r
**/\r
It also moves the pointer backward a node, to get prepared to be called\r
again.\r
\r
- @param[in,out] Descriptors Points to current position of a serial of address space\r
- descriptors.\r
- @param[out] MinBus The lower range of bus number.\r
- @param[out] ManBus The upper range of bus number.\r
- @param[out] IsEnd Meet end of the serial of descriptors.\r
+ @param[in, out] Descriptors Points to current position of a serial of address space\r
+ descriptors.\r
+ @param[out] MinBus The lower range of bus number.\r
+ @param[out] MaxBus The upper range of bus number.\r
+ @param[out] IsEnd Meet end of the serial of descriptors.\r
\r
@retval EFI_SUCCESS The command completed successfully.\r
**/\r
/**\r
Explain the Base Address Register(Bar) in PCI configuration space.\r
\r
- @param[in] Bar Points to the Base Address Register intended to interpret.\r
- @param[in] Command Points to the register Command.\r
- @param[in] Address Address used to access configuration space of this PCI device.\r
- @param[in] IoDev Handle used to access configuration space of PCI device.\r
- @param[in,out] Index The Index.\r
+ @param[in] Bar Points to the Base Address Register intended to interpret.\r
+ @param[in] Command Points to the register Command.\r
+ @param[in] Address Address used to access configuration space of this PCI device.\r
+ @param[in] IoDev Handle used to access configuration space of PCI device.\r
+ @param[in, out] Index The Index.\r
\r
@retval EFI_SUCCESS The command completed successfully.\r
**/\r
Handle is changed to the next handle or 0xFFFF when the end is\r
reached or the handle is not found.\r
\r
- @param[in,out] Handle 0xFFFF: get the first structure\r
- Others: get a structure according to this value.\r
- @param[in,out] Buffer The pointer to the caller's memory buffer.\r
- @param[out] Length Length of return buffer in bytes.\r
+ @param[in, out] Handle 0xFFFF: get the first structure\r
+ Others: get a structure according to this value.\r
+ @param[in, out] Buffer The pointer to the caller's memory buffer.\r
+ @param[out] Length Length of return buffer in bytes.\r
\r
@retval DMI_SUCCESS Buffer contains the required structure data\r
Handle is updated with next structure handle or\r
Handle is changed to the next handle or 0xFFFF when the end is\r
reached or the handle is not found.\r
\r
- @param[in,out] Handle 0xFFFF: get the first structure\r
- Others: get a structure according to this value.\r
- @param[in,out] Buffer The pointer to the caller's memory buffer.\r
- @param[out] Length Length of return buffer in bytes.\r
+ @param[in, out] Handle 0xFFFF: get the first structure\r
+ Others: get a structure according to this value.\r
+ @param[in, out] Buffer The pointer to the caller's memory buffer.\r
+ @param[out] Length Length of return buffer in bytes.\r
\r
@retval DMI_SUCCESS Buffer contains the required structure data\r
Handle is updated with next structure handle or\r
Copy Length of Src buffer to Dest buffer,\r
add a NULL termination to Dest buffer.\r
\r
- @param[in,out] Dest Destination buffer head.\r
- @param[in] Src Source buffer head.\r
- @param[in] Length Length of buffer to be copied.\r
+ @param[in, out] Dest Destination buffer head.\r
+ @param[in] Src Source buffer head.\r
+ @param[in] Length Length of buffer to be copied.\r
**/\r
VOID\r
MemToString (\r
Then all the Key Value between Low and High gets the same string\r
L"Unused".\r
\r
- @param[in] Table The begin address of table.\r
- @param[in] Number The number of table items.\r
- @param[in] Key The query Key.\r
- @param[in,out] Info Input as empty buffer; output as data buffer.\r
- @param[in] InfoLen The max number of characters for Info.\r
+ @param[in] Table The begin address of table.\r
+ @param[in] Number The number of table items.\r
+ @param[in] Key The query Key.\r
+ @param[in, out] Info Input as empty buffer; output as data buffer.\r
+ @param[in] InfoLen The max number of characters for Info.\r
\r
@return the found Key and Info is valid.\r
@retval QUERY_TABLE_UNFOUND and Info should be NULL.\r
Then all the Key Value between Low and High gets the same string\r
L"Unused".\r
\r
- @param[in] Table The begin address of table.\r
- @param[in] Number The number of table items.\r
- @param[in] Key The query Key.\r
- @param[in,out] Info Input as empty buffer; output as data buffer.\r
- @param[in] InfoLen The max number of characters for Info.\r
+ @param[in] Table The begin address of table.\r
+ @param[in] Number The number of table items.\r
+ @param[in] Key The query Key.\r
+ @param[in, out] Info Input as empty buffer; output as data buffer.\r
+ @param[in] InfoLen The max number of characters for Info.\r
\r
@return the found Key and Info is valid.\r
@retval QUERY_TABLE_UNFOUND and Info should be NULL.\r
Function returns a system configuration table that is stored in the\r
EFI System Table based on the provided GUID.\r
\r
- @param[in] TableGuid A pointer to the table's GUID type.\r
- @param[in,out] Table On exit, a pointer to a system configuration table.\r
+ @param[in] TableGuid A pointer to the table's GUID type.\r
+ @param[in, out] Table On exit, a pointer to a system configuration table.\r
\r
@retval EFI_SUCCESS A configuration table matching TableGuid was found.\r
@retval EFI_NOT_FOUND A configuration table matching TableGuid was not found.\r
/**\r
Convert a string representation of a guid to a Guid value.\r
\r
- @param[in] StringGuid The pointer to the string of a guid.\r
- @param[in,out] Guid The pointer to the GUID structure to populate.\r
+ @param[in] StringGuid The pointer to the string of a guid.\r
+ @param[in, out] Guid The pointer to the GUID structure to populate.\r
\r
@retval EFI_INVALID_PARAMETER A parameter was invalid.\r
@retval EFI_SUCCESS The conversion was successful.\r
Function returns a system configuration table that is stored in the\r
EFI System Table based on the provided GUID.\r
\r
- @param[in] TableGuid A pointer to the table's GUID type.\r
- @param[in,out] Table On exit, a pointer to a system configuration table.\r
+ @param[in] TableGuid A pointer to the table's GUID type.\r
+ @param[in, out] Table On exit, a pointer to a system configuration table.\r
\r
@retval EFI_SUCCESS A configuration table matching TableGuid was found.\r
@retval EFI_NOT_FOUND A configuration table matching TableGuid was not found.\r
/**\r
Convert a string representation of a GUID to the GUID value.\r
\r
- @param[in] StringGuid The pointer to the string containing a GUID printed.\r
- @param[in,out] Guid The pointer to the buffer to get the GUID value.\r
+ @param[in] StringGuid The pointer to the string containing a GUID printed.\r
+ @param[in, out] Guid The pointer to the buffer to get the GUID value.\r
**/\r
EFI_STATUS\r
EFIAPI\r
/**\r
Get lots of info about a device from its handle.\r
\r
- @param[in] TheHandle The device handle to get info on.\r
- @param[in,out] Type On successful return R, B, or D (root, bus, or \r
- device) will be placed in this buffer.\r
- @param[in,out] Cfg On successful return this buffer will be \r
- TRUE if the handle has configuration, FALSE\r
- otherwise.\r
- @param[in,out] Diag On successful return this buffer will be \r
- TRUE if the handle has disgnostics, FALSE\r
- otherwise.\r
- @param[in,out] Parents On successful return this buffer will be \r
- contain the number of parent handles.\r
- @param[in,out] Devices On successful return this buffer will be \r
- contain the number of devices controlled.\r
- @param[in,out] Children On successful return this buffer will be \r
- contain the number of child handles.\r
- @param[out] Name The pointer to a buffer that will be allocated\r
- and contain the string name of the handle.\r
- The caller must free this memory.\r
- @param[in] Language The language code as defined by the UEFI spec.\r
+ @param[in] TheHandle The device handle to get info on.\r
+ @param[in, out] Type On successful return R, B, or D (root, bus, or \r
+ device) will be placed in this buffer.\r
+ @param[in, out] Cfg On successful return this buffer will be \r
+ TRUE if the handle has configuration, FALSE\r
+ otherwise.\r
+ @param[in, out] Diag On successful return this buffer will be \r
+ TRUE if the handle has disgnostics, FALSE\r
+ otherwise.\r
+ @param[in, out] Parents On successful return this buffer will be \r
+ contain the number of parent handles.\r
+ @param[in, out] Devices On successful return this buffer will be \r
+ contain the number of devices controlled.\r
+ @param[in, out] Children On successful return this buffer will be \r
+ contain the number of child handles.\r
+ @param[out] Name The pointer to a buffer that will be allocated\r
+ and contain the string name of the handle.\r
+ The caller must free this memory.\r
+ @param[in] Language The language code as defined by the UEFI spec.\r
\r
@retval EFI_SUCCESS The info is there.\r
@retval EFI_INVALID_PARAMETER A parameter was invalid.\r
\r
/**\r
This function will populate the device path protocol parameter based on TheHandle.\r
- \r
- @param[in,out] DevPath On a sucessful return the device path to the handle.\r
+\r
+ @param[in] TheHandle Driver handle.\r
+ @param[in, out] FilePath On a sucessful return the device path to the handle.\r
\r
@retval EFI_SUCCESS The device path was sucessfully returned.\r
@retval other A error from gBS->HandleProtocol.\r
/**\r
Update the value of a given alias on the list. If the alias is not there then add it.\r
\r
- @param[in] Alias The alias to test for.\r
- @param[in] CommandString The updated command string.\r
- @param[in,out] List The list to search.\r
+ @param[in] Alias The alias to test for.\r
+ @param[in] CommandString The updated command string.\r
+ @param[in, out] List The list to search.\r
\r
@retval EFI_SUCCESS The operation was completed successfully.\r
@retval EFI_OUT_OF_RESOURCES There was not enough free memory.\r
/**\r
Remove an alias from the given list.\r
\r
- @param[in] Alias The alias to remove.\r
- @param[in,out] List The list to search.\r
+ @param[in] Alias The alias to remove.\r
+ @param[in, out] List The list to search.\r
**/\r
BOOLEAN\r
EFIAPI\r
/**\r
Extract the next fragment, if there is one.\r
\r
- @param[in,out] Statement The current remaining statement.\r
- @param[in] Fragment The current fragment.\r
+ @param[in, out] Statement The current remaining statement.\r
+ @param[in] Fragment The current fragment.\r
\r
@retval FALSE There is not another fragment.\r
@retval TRUE There is another fragment.\r
/**\r
Process an if statement and determine if its is valid or not.\r
\r
- @param[in,out] PassingState Opon entry, the current state. Upon exit, \r
- the new state.\r
- @param[in] StartParameterNumber The number of the first parameter of\r
- this statement.\r
- @param[in] EndParameterNumber The number of the final parameter of\r
- this statement.\r
- @param[in] OperatorToUse The type of termination operator.\r
- @param[in] CaseInsensitive TRUE for case insensitive, FALSE otherwise.\r
- @param[in] ForceStringCompare TRUE for all string based, FALSE otherwise.\r
+ @param[in, out] PassingState Opon entry, the current state. Upon exit, \r
+ the new state.\r
+ @param[in] StartParameterNumber The number of the first parameter of\r
+ this statement.\r
+ @param[in] EndParameterNumber The number of the final parameter of\r
+ this statement.\r
+ @param[in] OperatorToUse The type of termination operator.\r
+ @param[in] CaseInsensitive TRUE for case insensitive, FALSE otherwise.\r
+ @param[in] ForceStringCompare TRUE for all string based, FALSE otherwise.\r
\r
@retval EFI_INVALID_PARAMETER A parameter was invalid.\r
@retval EFI_SUCCESS The operation was successful. \r
\r
If label is used it will be used instead of the count.\r
\r
- @param[in] Function The function to use to enumerate through the \r
- list. Normally GetNextNode or GetPreviousNode.\r
- @param[in] DecrementerTag The tag to decrement the count at.\r
- @param[in] IncrementerTag The tag to increment the count at.\r
- @param[in] Label A label to look for.\r
- @param[in,out] ScriptFile The pointer to the current script file structure.\r
- @param[in] MovePast TRUE makes function return 1 past the found \r
- location.\r
- @param[in] FindOnly TRUE to not change the ScriptFile.\r
- @param[in] CommandNode The pointer to the Node to test.\r
- @param[in,out] TargetCount The pointer to the current count.\r
+ @param[in] Function The function to use to enumerate through the \r
+ list. Normally GetNextNode or GetPreviousNode.\r
+ @param[in] DecrementerTag The tag to decrement the count at.\r
+ @param[in] IncrementerTag The tag to increment the count at.\r
+ @param[in] Label A label to look for.\r
+ @param[in, out] ScriptFile The pointer to the current script file structure.\r
+ @param[in] MovePast TRUE makes function return 1 past the found \r
+ location.\r
+ @param[in] FindOnly TRUE to not change the ScriptFile.\r
+ @param[in] CommandNode The pointer to the Node to test.\r
+ @param[in, out] TargetCount The pointer to the current count.\r
**/\r
BOOLEAN\r
EFIAPI\r
\r
If label is used it will be used instead of the count.\r
\r
- @param[in] Function The function to use to enumerate through the \r
- list. Normally GetNextNode or GetPreviousNode.\r
- @param[in] DecrementerTag The tag to decrement the count at.\r
- @param[in] IncrementerTag The tag to increment the count at.\r
- @param[in] Label A label to look for.\r
- @param[in,out] ScriptFile The pointer to the current script file structure.\r
- @param[in] MovePast TRUE makes function return 1 past the found \r
- location.\r
- @param[in] FindOnly TRUE to not change the ScriptFile.\r
- @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in \r
- searching.\r
+ @param[in] Function The function to use to enumerate through the \r
+ list. Normally GetNextNode or GetPreviousNode.\r
+ @param[in] DecrementerTag The tag to decrement the count at.\r
+ @param[in] IncrementerTag The tag to increment the count at.\r
+ @param[in] Label A label to look for.\r
+ @param[in, out] ScriptFile The pointer to the current script file structure.\r
+ @param[in] MovePast TRUE makes function return 1 past the found \r
+ location.\r
+ @param[in] FindOnly TRUE to not change the ScriptFile.\r
+ @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in \r
+ searching.\r
**/\r
BOOLEAN\r
EFIAPI\r
\r
If label is used it will be used instead of the count.\r
\r
- @param[in] Function The function to use to enumerate through the \r
- list. Normally GetNextNode or GetPreviousNode.\r
- @param[in] DecrementerTag The tag to decrement the count at.\r
- @param[in] IncrementerTag The tag to increment the count at.\r
- @param[in] Label A label to look for.\r
- @param[in,out] ScriptFile The pointer to the current script file structure.\r
- @param[in] MovePast TRUE makes function return 1 past the found \r
- location.\r
- @param[in] FindOnly TRUE to not change the ScriptFile.\r
- @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in \r
- searching.\r
+ @param[in] Function The function to use to enumerate through the \r
+ list. Normally GetNextNode or GetPreviousNode.\r
+ @param[in] DecrementerTag The tag to decrement the count at.\r
+ @param[in] IncrementerTag The tag to increment the count at.\r
+ @param[in] Label A label to look for.\r
+ @param[in, out] ScriptFile The pointer to the current script file structure.\r
+ @param[in] MovePast TRUE makes function return 1 past the found \r
+ location.\r
+ @param[in] FindOnly TRUE to not change the ScriptFile.\r
+ @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in \r
+ searching.\r
**/\r
BOOLEAN\r
EFIAPI\r
\r
if the result is sucessful the caller must free *DestPathPointer.\r
\r
- @param[in] DestDir The original path to the destination.\r
- @param[in,out] DestPathPointer A pointer to the callee allocated final path.\r
- @param[in] Cwd A pointer to the current working directory.\r
+ @param[in] DestDir The original path to the destination.\r
+ @param[in, out] DestPathPointer A pointer to the callee allocated final path.\r
+ @param[in] Cwd A pointer to the current working directory.\r
\r
@retval EFI_INVALID_PARAMETR The DestDir could not be resolved to a location.\r
@retval EFI_INVALID_PARAMETR The DestDir could be resolved to more than 1 location.\r
EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via\r
the ShellCloseFileMetaArg function.\r
\r
- @param[in] FileList the EFI shell list type\r
- @param[in,out] ListHead the list to add to\r
+ @param[in] FileList the EFI shell list type\r
+ @param[in, out] ListHead the list to add to\r
\r
@retval the resultant head of the double linked new format list;\r
**/\r
\r
If the string would grow bigger than NewSize it will halt and return error.\r
\r
- @param[in] SourceString The string with source buffer.\r
- @param[in,out] NewString The string with resultant buffer.\r
- @param[in] NewSize The size in bytes of NewString.\r
- @param[in] FindTarget The string to look for.\r
- @param[in] ReplaceWith The string to replace FindTarget with.\r
- @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r
- immediately before it.\r
- @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r
+ @param[in] SourceString The string with source buffer.\r
+ @param[in, out] NewString The string with resultant buffer.\r
+ @param[in] NewSize The size in bytes of NewString.\r
+ @param[in] FindTarget The string to look for.\r
+ @param[in] ReplaceWith The string to replace FindTarget with.\r
+ @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r
+ immediately before it.\r
+ @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r
\r
@retval EFI_INVALID_PARAMETER SourceString was NULL.\r
@retval EFI_INVALID_PARAMETER NewString was NULL.\r
if Destination's current length (including NULL terminator) is already more then\r
CurrentSize, then ASSERT()\r
\r
- @param[in,out] Destination The String to append onto\r
- @param[in,out] CurrentSize on call the number of bytes in Destination. On\r
+ @param[in, out] Destination The String to append onto\r
+ @param[in, out] CurrentSize on call the number of bytes in Destination. On\r
return possibly the new size (still in bytes). if NULL\r
then allocate whatever is needed.\r
@param[in] Source The String to append from\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle SHELL_FILE_HANDLE to read from.\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
+ @param[in] Handle SHELL_FILE_HANDLE to read from.\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is\r
+ Ascii (TRUE) or UCS2 (FALSE).\r
\r
@return The line of text from the file.\r
\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle SHELL_FILE_HANDLE to read from.\r
- @param[in,out] Buffer The pointer to buffer to read into.\r
- @param[in,out] Size The pointer to number of bytes in Buffer.\r
- @param[in] Truncate If the buffer is large enough, this has no effect.\r
- If the buffer is is too small and Truncate is TRUE,\r
- the line will be truncated.\r
- If the buffer is is too small and Truncate is FALSE,\r
- then no read will occur.\r
-\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
+ @param[in] Handle SHELL_FILE_HANDLE to read from.\r
+ @param[in, out] Buffer The pointer to buffer to read into.\r
+ @param[in, out] Size The pointer to number of bytes in Buffer.\r
+ @param[in] Truncate If the buffer is large enough, this has no effect.\r
+ If the buffer is is too small and Truncate is TRUE,\r
+ the line will be truncated.\r
+ If the buffer is is too small and Truncate is FALSE,\r
+ then no read will occur.\r
+\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is\r
+ Ascii (TRUE) or UCS2 (FALSE).\r
\r
@retval EFI_SUCCESS The operation was successful. The line is stored in\r
Buffer.\r
/**\r
Append OFFSET/WIDTH/VALUE items at the beginning of string.\r
\r
- @param[in,out] String The pointer to the string to append onto.\r
- @param[in] Offset Offset value.\r
- @param[in] Width Width value.\r
- @param[in] Block Point to data buffer.\r
+ @param[in, out] String The pointer to the string to append onto.\r
+ @param[in] Offset Offset value.\r
+ @param[in] Width Width value.\r
+ @param[in] Block Point to data buffer.\r
\r
@return The count of unicode character that were appended.\r
**/\r
if Count is < 2 then perform no action.\r
if Size is < 1 then perform no action.\r
\r
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements\r
- on return a buffer of sorted elements\r
- @param[in] Count the number of elements in the buffer to sort\r
- @param[in] ElementSize Size of an element in bytes\r
- @param[in] CompareFunction The function to call to perform the comparison\r
- of any 2 elements\r
- @param[in] Buffer Buffer of size ElementSize for use in swapping\r
+ @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements\r
+ on return a buffer of sorted elements\r
+ @param[in] Count the number of elements in the buffer to sort\r
+ @param[in] ElementSize Size of an element in bytes\r
+ @param[in] CompareFunction The function to call to perform the comparison\r
+ of any 2 elements\r
+ @param[in] Buffer Buffer of size ElementSize for use in swapping\r
**/\r
VOID\r
EFIAPI\r
if Count is < 2 then perform no action.\r
if Size is < 1 then perform no action.\r
\r
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements\r
- on return a buffer of sorted elements\r
- @param[in] Count the number of elements in the buffer to sort\r
- @param[in] ElementSize Size of an element in bytes\r
- @param[in] CompareFunction The function to call to perform the comparison\r
- of any 2 elements\r
+ @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements\r
+ on return a buffer of sorted elements\r
+ @param[in] Count the number of elements in the buffer to sort\r
+ @param[in] ElementSize Size of an element in bytes\r
+ @param[in] CompareFunction The function to call to perform the comparison\r
+ of any 2 elements\r
**/\r
VOID\r
EFIAPI\r
projects / mirror_edk2.git / commitdiff