Skip to content

Latest commit

 

History

History
89 lines (66 loc) · 3.92 KB

nf-setupapi-setupdigetdeviceinstallparamsa.md

File metadata and controls

89 lines (66 loc) · 3.92 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.SetupDiGetDeviceInstallParamsA
SetupDiGetDeviceInstallParamsA function (setupapi.h)
The SetupDiGetDeviceInstallParams function retrieves device installation parameters for a device information set or a particular device information element. (ANSI)
SetupDiGetDeviceInstallParamsA
di-rtns_417ee0d9-f9c6-44a2-b4b4-4787fe9e952b.xml
devinst\setupdigetdeviceinstallparams.htm
devinst
e5e8c203-cf71-4cb4-a7a8-5af3a2483eea
12/05/2018
SetupDiGetDeviceInstallParams, SetupDiGetDeviceInstallParams function [Device and Driver Installation], SetupDiGetDeviceInstallParamsA, SetupDiGetDeviceInstallParamsW, devinst.setupdigetdeviceinstallparams, di-rtns_417ee0d9-f9c6-44a2-b4b4-4787fe9e952b.xml, setupapi/SetupDiGetDeviceInstallParams
setupapi.h
Setupapi.h
Desktop
Available in Microsoft Windows 2000 and later versions of Windows.
Setupapi.lib
Windows
19H1
SetupDiGetDeviceInstallParamsA
setupapi/SetupDiGetDeviceInstallParamsA
c++
APIRef
kbSyntax
LibDef
Setupapi.lib
Setupapi.dll
SetupDiGetDeviceInstallParams - SetupDiGetDeviceInstallParamsA

SetupDiGetDeviceInstallParamsA function

-description

The SetupDiGetDeviceInstallParams function retrieves device installation parameters for a device information set or a particular device information element.

-parameters

-param DeviceInfoSet [in]

A handle to the device information set that contains the device installation parameters to retrieve.

-param DeviceInfoData [in, optional]

A pointer to an SP_DEVINFO_DATA structure that specifies the device information element in DeviceInfoSet. This parameter is optional and can be NULL. If this parameter is specified, SetupDiGetDeviceInstallParams retrieves the installation parameters for the specified device. If this parameter is NULL, the function retrieves the global device installation parameters that are associated with DeviceInfoSet.

-param DeviceInstallParams [out]

A pointer to an SP_DEVINSTALL_PARAMS structure that receives the device install parameters. DeviceInstallParams.cbSize must be set to the size, in bytes, of the structure before calling this function.

-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

SP_DEVINFO_DATA

SP_DEVINSTALL_PARAMS

SetupDiSetDeviceInstallParams

-remarks

Note

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