]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Include/Library/HandleParsingLib.h
ShellPkg/UefiHandleParsingLib: fix IN/OUT notation in child ctrlr parsing
[mirror_edk2.git] / ShellPkg / Include / Library / HandleParsingLib.h
index 1c9ed49d6c118e48fb32477b438c49eae7b0172e..79dcc9cc5a557a9f4b1d10d2a0cc421d9513cacb 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Provides interface to advanced shell functionality for parsing both handle and protocol database.\r
 \r
-  Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -306,7 +306,7 @@ ParseHandleDatabaseForChildDevices(
   Gets handles for any child controllers of the passed in controller.\r
 \r
   @param[in] ControllerHandle       The handle of the "parent controller".\r
-  @param[in] MatchingHandleCount    The pointer to the number of handles in\r
+  @param[out] MatchingHandleCount   The pointer to the number of handles in\r
                                     MatchingHandleBuffer on return.\r
   @param[out] MatchingHandleBuffer  The buffer containing handles on a successful\r
                                     return.\r
@@ -317,7 +317,7 @@ EFI_STATUS
 EFIAPI\r
 ParseHandleDatabaseForChildControllers(\r
   IN CONST EFI_HANDLE       ControllerHandle,\r
-  IN UINTN                  *MatchingHandleCount,\r
+  OUT UINTN                 *MatchingHandleCount,\r
   OUT EFI_HANDLE            **MatchingHandleBuffer OPTIONAL\r
   );\r
 \r
@@ -357,6 +357,8 @@ ConvertHandleIndexToHandle(
 /**\r
   Function to get all handles that support a given protocol or all handles.\r
 \r
+  The caller is responsible to free this memory.\r
+\r
   @param[in] ProtocolGuid The guid of the protocol to get handles for.  If NULL\r
                           then the function will return all handles.\r
 \r
@@ -372,6 +374,8 @@ GetHandleListByProtocol (
 /**\r
   Function to get all handles that support some protocols.\r
 \r
+  The caller is responsible to free this memory.\r
+\r
   @param[in] ProtocolGuids  A NULL terminated list of protocol GUIDs.\r
 \r
   @retval NULL              A memory allocation failed.\r