Add documentation to SetupDiBuildClassInfoList/SetupDiBuildClassInfoListExA/W
authorHervé Poussineau <hpoussin@reactos.org>
Fri, 9 Jun 2006 14:16:39 +0000 (14:16 +0000)
committerHervé Poussineau <hpoussin@reactos.org>
Fri, 9 Jun 2006 14:16:39 +0000 (14:16 +0000)
Patch by Christian Gmeiner on wine-patches ML

svn path=/trunk/; revision=22292

reactos/dll/win32/setupapi/devclass.c

index d497908..00beb1f 100644 (file)
@@ -99,6 +99,19 @@ static const UPDATE_CLASS_PARAM_HANDLER UpdateClassInstallParamHandlers[] = {
 
 /***********************************************************************
  *              SetupDiBuildClassInfoList  (SETUPAPI.@)
+ *
+ * Returns a list of setup class GUIDs that identify the classes
+ * that are installed on a local machine.
+ *
+ * PARAMS
+ *   Flags [I] control exclusion of classes from the list.
+ *   ClassGuidList [O] pointer to a GUID-typed array that receives a list of setup class GUIDs.
+ *   ClassGuidListSize [I] The number of GUIDs in the array (ClassGuidList).
+ *   RequiredSize [O] pointer, which receives the number of GUIDs that are returned.
+ *
+ * RETURNS
+ *   Success: TRUE.
+ *   Failure: FALSE.
  */
 BOOL WINAPI
 SetupDiBuildClassInfoList(
@@ -115,6 +128,18 @@ SetupDiBuildClassInfoList(
 
 /***********************************************************************
  *              SetupDiBuildClassInfoListExA  (SETUPAPI.@)
+ *
+ * PARAMS
+ *   Flags [I] control exclusion of classes from the list.
+ *   ClassGuidList [O] pointer to a GUID-typed array that receives a list of setup class GUIDs.
+ *   ClassGuidListSize [I] The number of GUIDs in the array (ClassGuidList).
+ *   RequiredSize [O] pointer, which receives the number of GUIDs that are returned.
+ *   MachineName [I] name of a remote machine.
+ *   Reserved [I] must be NULL.
+ *
+ * RETURNS
+ *   Success: TRUE.
+ *   Failure: FALSE.
  */
 BOOL WINAPI
 SetupDiBuildClassInfoListExA(
@@ -147,7 +172,22 @@ SetupDiBuildClassInfoListExA(
 }
 
 /***********************************************************************
- *             SetupDiBuildClassInfoListExW  (SETUPAPI.@)
+ *              SetupDiBuildClassInfoListExW  (SETUPAPI.@)
+ *
+ * Returns a list of setup class GUIDs that identify the classes
+ * that are installed on a local or remote macine.
+ *
+ * PARAMS
+ *   Flags [I] control exclusion of classes from the list.
+ *   ClassGuidList [O] pointer to a GUID-typed array that receives a list of setup class GUIDs.
+ *   ClassGuidListSize [I] The number of GUIDs in the array (ClassGuidList).
+ *   RequiredSize [O] pointer, which receives the number of GUIDs that are returned.
+ *   MachineName [I] name of a remote machine.
+ *   Reserved [I] must be NULL.
+ *
+ * RETURNS
+ *   Success: TRUE.
+ *   Failure: FALSE.
  */
 BOOL WINAPI
 SetupDiBuildClassInfoListExW(