Expand Minimize

SetupDiGetHwProfileFriendlyName function

The SetupDiGetHwProfileFriendlyName function retrieves the friendly name associated with a hardware profile ID.

Syntax


BOOL SetupDiGetHwProfileFriendlyName(
  _In_       DWORD HwProfile,
  _Out_      PSTR FriendlyName,
  _In_       DWORD FriendlyNameSize,
  _Out_opt_  PDWORD RequiredSize
);

Parameters

HwProfile [in]

The hardware profile ID associated with the friendly name to retrieve. If this parameter is 0, the friendly name for the current hardware profile is retrieved.

FriendlyName [out]

A pointer to a string buffer to receive the friendly name.

FriendlyNameSize [in]

The size, in characters, of the FriendlyName buffer.

RequiredSize [out, optional]

A pointer to a variable of type DWORD that receives the number of characters required to retrieve the friendly name (including a NULL terminator).

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 SetupDiGetHwProfileFriendlyNameEx to get the friendly name of a hardware profile ID on a remote computer.

Requirements

Version

Available in Microsoft Windows 2000 and later versions of Windows.

Header

Setupapi.h (include Setupapi.h)

Library

Setupapi.lib

See also

SetupDiGetHwProfileFriendlyNameEx
SetupDiGetHwProfileList

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft