SetupDiGetHwProfileFriendlyNameEx function

The SetupDiGetHwProfileFriendlyNameEx function retrieves the friendly name associated with a hardware profile ID on a local or remote computer.

Syntax


BOOL SetupDiGetHwProfileFriendlyNameEx(
  _In_       DWORD  HwProfile,
  _Out_      PTSTR  FriendlyName,
  _In_       DWORD  FriendlyNameSize,
  _Out_opt_  PDWORD RequiredSize,
  _In_opt_   PCTSTR MachineName,
  _Reserved_ PVOID  Reserved
);

Parameters

HwProfile [in]

Supplies 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 character buffer to receive the friendly name.

FriendlyNameSize [in]

The size, in characters, of the FriendlyName buffer.

RequiredSize [out, optional]

A pointer to a variable to receive the number of characters required to store the friendly name (including a NULL terminator). This parameter is optional and can be NULL.

MachineName [in, optional]

A pointer to NULL-terminated string that contains the name of a remote computer on which the hardware profile ID resides. This parameter is optional and can be NULL. If MachineName is NULL, the hardware profile ID is on the local computer.

Reserved

Must be NULL.

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.

Requirements

Target platform

Desktop

Version

Available in Microsoft Windows 2000 and later versions of Windows.

Header

Setupapi.h (include Setupapi.h)

Library

Setupapi.lib

See also

SetupDiGetHwProfileFriendlyName
SetupDiGetHwProfileListEx

 

 

Send comments about this topic to Microsoft

Show: