MdePkg/UnitTestLib.h: Drop FrameworkHandle param from SaveFrameworkState()

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2612

The framework handle can be retrieved from GetActiveFrameworkHandle()
internal to SaveFrameworkState() so this change removes the parameter
from the function signature.

Cc: Bret Barkelew <brbarkel@microsoft.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Zhiguang Liu <zhiguang.liu@intel.com>

diff --git a/MdePkg/Include/Library/UnitTestLib.h b/MdePkg/Include/Library/UnitTestLib.h
index c06c36bea5aabc898cdbd65096ea8c2b1c6648fd..a4374580a8d58fceac737132d8ea5efe5d73d943 100644 (file)
--- a/MdePkg/Include/Library/UnitTestLib.h
+++ b/MdePkg/Include/Library/UnitTestLib.h
@@ -313,11 +313,9 @@ FreeUnitTestFramework (
   at least the current execution count) which will be saved by the framework and\r
   passed to the test case upon resume.\r
 \r
-  Generally called from within a test case prior to quitting or rebooting.\r
+  This should be called while the current test framework is valid and active. It is\r
+  generally called from within a test case prior to quitting or rebooting.\r
 \r
-  @param[in]  FrameworkHandle    A handle to the current running framework that\r
-                                 dispatched the test.  Necessary for recording\r
-                                 certain test events with the framework.\r
   @param[in]  ContextToSave      A buffer of test case-specific data to be saved\r
                                  along with framework state.  Will be passed as\r
                                  "Context" to the test case upon resume.  This\r
@@ -325,7 +323,7 @@ FreeUnitTestFramework (
   @param[in]  ContextToSaveSize  Size of the ContextToSave buffer.\r
 \r
   @retval  EFI_SUCCESS            The framework state and context were saved.\r
-  @retval  EFI_INVALID_PARAMETER  FrameworkHandle is NULL.\r
+  @retval  EFI_NOT_FOUND          An active framework handle was not found.\r
   @retval  EFI_INVALID_PARAMETER  ContextToSave is not NULL and\r
                                   ContextToSaveSize is 0.\r
   @retval  EFI_INVALID_PARAMETER  ContextToSave is >= 4GB.\r
@@ -338,7 +336,6 @@ FreeUnitTestFramework (
 EFI_STATUS\r
 EFIAPI\r
 SaveFrameworkState (\r
-  IN UNIT_TEST_FRAMEWORK_HANDLE  FrameworkHandle,\r
   IN UNIT_TEST_CONTEXT           ContextToSave     OPTIONAL,\r
   IN UINTN                       ContextToSaveSize\r
   );\r