ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER

ShellParametersProtocol::UpdateArgcArgv() can return
a EFI_INVALID_PARAMETER value. Document it.

Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
This commit is contained in:
Philippe Mathieu-Daud? 2019-12-03 01:40:51 +08:00 committed by mergify[bot]
parent ddb7050c68
commit 7f9e354a01
2 changed files with 3 additions and 0 deletions

View File

@ -1340,7 +1340,9 @@ RestoreStdInStdOutStdErr (
@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 successful, Argv and Argc are valid.
@return EFI_INVALID_PARAMETER Some parameters are invalid.
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
**/
EFI_STATUS

View File

@ -71,6 +71,7 @@ CleanUpShellParametersProtocol (
@param[out] OldArgc pointer to old number of items in Argv list
@retval EFI_SUCCESS operation was successful, Argv and Argc are valid
@return EFI_INVALID_PARAMETER some parameters are invalid
@retval EFI_OUT_OF_RESOURCES a memory allocation failed.
**/
EFI_STATUS