X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=ShellPkg%2FApplication%2FShell%2FShellParametersProtocol.h;fp=ShellPkg%2FApplication%2FShell%2FShellParametersProtocol.h;h=398147c8bd4c31292581eebd15d150134d6abf06;hp=df0316a03091d1a811b5551021b7d5882debf70f;hb=6a5033ca3e8868a176a9671d55ad297bac385b1b;hpb=ba562ca040404796ab1018e769e886aa6b861bd1 diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.h b/ShellPkg/Application/Shell/ShellParametersProtocol.h index df0316a030..398147c8bd 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.h +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h @@ -43,7 +43,7 @@ CreatePopulateInstallShellParametersProtocol ( ); /** - frees all memory used by createion and installation of shell parameters protocol + frees all memory used by creation and installation of shell parameters protocol and if there was an old version installed it will restore that one. @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is @@ -60,7 +60,7 @@ CleanUpShellParametersProtocol ( ); /** - Funcion will replace the current Argc and Argv in the ShellParameters protocol + Function will replace the current Argc and Argv in the ShellParameters protocol structure by parsing NewCommandLine. The current values are returned to the user. @@ -70,7 +70,7 @@ CleanUpShellParametersProtocol ( @param[out] OldArgv pointer to old list of parameters @param[out] OldArgc pointer to old number of items in Argv list - @retval EFI_SUCCESS operation was sucessful, Argv and Argc are valid + @retval EFI_SUCCESS operation was successful, Argv and Argc are valid @retval EFI_OUT_OF_RESOURCES a memory allocation failed. **/ EFI_STATUS @@ -83,7 +83,7 @@ UpdateArgcArgv( ); /** - Funcion will replace the current Argc and Argv in the ShellParameters protocol + Function will replace the current Argc and Argv in the ShellParameters protocol structure with Argv and Argc. The current values are de-allocated and the OldArgv must not be deallocated by the caller. @@ -108,7 +108,7 @@ typedef struct { } SYSTEM_TABLE_INFO; /** - Funcion will replace the current StdIn and StdOut in the ShellParameters protocol + Function will replace the current StdIn and StdOut in the ShellParameters protocol structure by parsing NewCommandLine. The current values are returned to the user. @@ -121,7 +121,7 @@ typedef struct { @param[out] OldStdErr Pointer to old StdErr. @param[out] SystemTableInfo Pointer to old system table information. - @retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid. + @retval EFI_SUCCESS Operation was successful, Argv and Argc are valid. @retval EFI_OUT_OF_RESOURCES A memory allocation failed. **/ EFI_STATUS @@ -135,7 +135,7 @@ UpdateStdInStdOutStdErr( ); /** - Funcion will replace the current StdIn and StdOut in the ShellParameters protocol + Function will replace the current StdIn and StdOut in the ShellParameters protocol structure with StdIn and StdOut. The current values are de-allocated. @param[in, out] ShellParameters Pointer to parameter structure to modify. @@ -166,7 +166,7 @@ RestoreStdInStdOutStdErr ( @param[in, out] Argv pointer to array of strings; one for each parameter @param[in, out] Argc pointer to number of strings in Argv array - @return EFI_SUCCESS the operation was sucessful + @return EFI_SUCCESS the operation was successful @return EFI_OUT_OF_RESOURCES a memory allocation failed. **/ EFI_STATUS @@ -188,13 +188,13 @@ ParseCommandLineToArgs( function. @param[in, out] Walker pointer to string of command line. Adjusted to - reminaing command line on return + remaining command line on return @param[in, out] TempParameter pointer to string of command line item extracted. @param[in] Length Length of (*TempParameter) in bytes @param[in] StripQuotation if TRUE then strip the quotation marks surrounding the parameters. - @return EFI_INALID_PARAMETER A required parameter was NULL or pointed to a NULL or empty string. + @return EFI_INVALID_PARAMETER A required parameter was NULL or pointed to a NULL or empty string. @return EFI_NOT_FOUND A closing " could not be found on the specified string **/ EFI_STATUS