SetupDiClassGuidsFromNameA function (setupapi.h)

  • Article

The SetupDiClassGuidsFromName function retrieves the GUID(s) associated with the specified class name. This list is built based on the classes currently installed on the system.

Syntax

WINSETUPAPI BOOL SetupDiClassGuidsFromNameA(
  [in]  PCSTR  ClassName,
  [out] LPGUID ClassGuidList,
  [in]  DWORD  ClassGuidListSize,
  [out] PDWORD RequiredSize
);

Parameters

[in] ClassName

The name of the class for which to retrieve the class GUID.

[out] ClassGuidList

A pointer to an array to receive the list of GUIDs associated with the specified class name.

[in] ClassGuidListSize

The number of GUIDs in the ClassGuidList array.

[out] RequiredSize

Supplies a pointer to a variable that receives the number of GUIDs associated with the class name. If this number is greater than the size of the ClassGuidList buffer, the number indicates how large the array must be in order to store all the GUIDs.

Return value

The function returns TRUE if it is successful. Otherwise, it returns FALSE and the logged error can be retrieved by making a call to GetLastError.

Remarks

Call SetupDiClassGuidsFromNameEx to retrieve the class GUIDs for a class on a remote computer.

Note

The setupapi.h header defines SetupDiClassGuidsFromName as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Available in Microsoft Windows 2000 and later versions of Windows.
Target Platform Desktop
Header setupapi.h (include Setupapi.h)
Library Setupapi.lib

See also

SetupDiClassGuidsFromNameEx

SetupDiClassNameFromGuid