SetupDiGetHwProfileFriendlyName

BOOLEAN
    SetupDiGetHwProfileFriendlyName(
        IN DWORD  HwProfile,
        OUT PTSTR  FriendlyName,
        IN DWORD  FriendlyNameSize,
        OUT PDWORD  RequiredSize    /* optional */
        );

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

Parameters

HwProfile

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

Supplies a pointer to a character buffer to receive the friendly name.

FriendlyNameSize

Supplies the size, in characters, of the FriendlyName buffer.

RequiredSize

Supplies a pointer to a variable to receive the number of characters required to store the friendly name (including the terminating 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.

See Also

SetupDiGetHwProfileList