From 7f9e354a01d77f0b392832525ccffde95ce1e95b Mon Sep 17 00:00:00 2001 From: Philippe Mathieu-Daud? Date: Tue, 3 Dec 2019 01:40:51 +0800 Subject: ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER ShellParametersProtocol::UpdateArgcArgv() can return a EFI_INVALID_PARAMETER value. Document it. Reviewed-by: Zhichao Gao Signed-off-by: Philippe Mathieu-Daude --- ShellPkg/Application/Shell/ShellParametersProtocol.c | 2 ++ ShellPkg/Application/Shell/ShellParametersProtocol.h | 1 + 2 files changed, 3 insertions(+) (limited to 'ShellPkg/Application') diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c index db5fbc1baf..7e0c8ce42e 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.c +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c @@ -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 diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.h b/ShellPkg/Application/Shell/ShellParametersProtocol.h index 717552b533..c50250696a 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.h +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h @@ -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 -- cgit v1.2.3