Skip to content

Latest commit

 

History

History
101 lines (74 loc) · 4.11 KB

nf-setupapi-setupdigethwprofilefriendlynameexw.md

File metadata and controls

101 lines (74 loc) · 4.11 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:setupapi.SetupDiGetHwProfileFriendlyNameExW
SetupDiGetHwProfileFriendlyNameExW function (setupapi.h)
The SetupDiGetHwProfileFriendlyNameEx function retrieves the friendly name associated with a hardware profile ID on a local or remote computer. (Unicode)
SetupDiGetHwProfileFriendlyNameEx
SetupDiGetHwProfileFriendlyNameEx function [Device and Driver Installation]
SetupDiGetHwProfileFriendlyNameExW
devinst.setupdigethwprofilefriendlynameex
di-rtns_43d54c1e-047c-491c-93a1-cd5eff918a58.xml
setupapi/SetupDiGetHwProfileFriendlyNameEx
devinst\setupdigethwprofilefriendlynameex.htm
devinst
839c1e4c-cfa6-4f59-979c-24623a040d5c
01/30/2023
SetupDiGetHwProfileFriendlyNameEx, SetupDiGetHwProfileFriendlyNameEx function [Device and Driver Installation], SetupDiGetHwProfileFriendlyNameExA, SetupDiGetHwProfileFriendlyNameExW, devinst.setupdigethwprofilefriendlynameex, di-rtns_43d54c1e-047c-491c-93a1-cd5eff918a58.xml, setupapi/SetupDiGetHwProfileFriendlyNameEx
setupapi.h
Setupapi.h
Desktop
Available in Microsoft Windows 2000 and later versions of Windows.
Setupapi.lib
Windows
19H1
SetupDiGetHwProfileFriendlyNameExW
setupapi/SetupDiGetHwProfileFriendlyNameExW
c++
APIRef
kbSyntax
LibDef
Setupapi.lib
Setupapi.dll
SetupDiGetHwProfileFriendlyNameEx
SetupDiGetHwProfileFriendlyNameExW

SetupDiGetHwProfileFriendlyNameExW function

-description

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

-parameters

-param 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.

-param FriendlyName [out]

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

-param FriendlyNameSize [in]

The size, in characters, of the FriendlyName buffer.

-param 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.

-param 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.

Caution

Using this function to access remote machines is not supported beginning with Windows 8 and Windows Server 2012, as this functionality has been removed.

-param Reserved

Must be NULL.

-returns

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.

-see-also

SetupDiGetHwProfileFriendlyName

SetupDiGetHwProfileListEx

-remarks

Note

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