SetupDiGetINFClassA function (setupapi.h)

Article
02/09/2023

The SetupDiGetINFClass function returns the class of a specified device INF file.

Syntax

WINSETUPAPI BOOL SetupDiGetINFClassA(
  [in]            PCSTR  InfName,
  [out]           LPGUID ClassGuid,
  [out]           PSTR   ClassName,
  [in]            DWORD  ClassNameSize,
  [out, optional] PDWORD RequiredSize
);

Parameters

[in] InfName

A pointer to a NULL-terminated string that supplies the name of a device INF file. This name can include a path. However, if just the file name is specified, the file is searched for in each directory that is listed in the DevicePath entry under the HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion subkey of the registry. The maximum length in characters, including a NULL terminator, of a NULL-terminated INF file name is MAX_PATH.

[out] ClassGuid

A pointer to a variable of type GUID that receives the class GUID for the specified INF file. If the INF file does not specify a class name, the function returns a GUID_NULL structure. Call SetupDiClassGuidsFromName to determine whether one or more classes with this name are already installed.

[out] ClassName

A pointer to a buffer that receives a NULL-terminated string that contains the name of the class for the specified INF file. If the INF file does not specify a class name but does specify a GUID, this buffer receives the name that is retrieved by calling SetupDiClassNameFromGuid. However, if SetupDiClassNameFromGuid cannot retrieve a class name (for example, the class is not installed), it returns an empty string.

[in] ClassNameSize

The size, in characters, of the buffer that is pointed to by the ClassName parameter. The maximum length of a NULL-terminated class name, in characters, is MAX_CLASS_NAME_LEN.

[out, optional] RequiredSize

A pointer to a DWORD-typed variable that receives the number of characters that are required to store the class name, including a terminating NULL. This pointer is optional and can be NULL.

Return value

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

Remarks

Do not use this function with INF files for Windows 9x or Millennium Edition.

Note

The setupapi.h header defines SetupDiGetINFClass 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