SetupDiGetDriverInstallParamsA function (setupapi.h)

  • Article

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

Syntax

WINSETUPAPI BOOL SetupDiGetDriverInstallParamsA(
  [in]           HDEVINFO              DeviceInfoSet,
  [in, optional] PSP_DEVINFO_DATA      DeviceInfoData,
  [in]           PSP_DRVINFO_DATA_A    DriverInfoData,
  [out]          PSP_DRVINSTALL_PARAMS DriverInstallParams
);

Parameters

[in] DeviceInfoSet

A handle to a device information set that contains a driver information element that represents the driver for which to retrieve installation parameters.

[in, optional] DeviceInfoData

A pointer to an SP_DEVINFO_DATA structure that contains a device information element that represents the device for which to retrieve installation parameters. This parameter is optional and can be NULL. If this parameter is specified, SetupDiGetDriverInstallParams retrieves information about a driver that is a member of a driver list for the specified device. If this parameter is NULL, SetupDiGetDriverInstallParams retrieves information about a driver that is a member of the global class driver list for DeviceInfoSet.

[in] DriverInfoData

A pointer to an SP_DRVINFO_DATA structure that specifies the driver information element that represents the driver for which to retrieve installation parameters. If DeviceInfoData is supplied, the driver must be a member of the driver list for the device that is specified by DeviceInfoData. Otherwise, the driver must be a member of the global class driver list for DeviceInfoSet.

[out] DriverInstallParams

A pointer to an SP_DRVINSTALL_PARAMS structure to receive the installation parameters for this driver.

Return value

The function returns TRUE if it is successful. Otherwise, it returns FALSE and the logged error can be retrieved by a call to GetLastError.

Remarks

Note

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

Requirements

Requirement Value
Minimum supported client Available in Microsoft Windows 2000 and later versions of Windows.
Target Platform Desktop
Header setupapi.h (include Setupapi.h)
Library Setupapi.lib

See also

SetupDiSetDriverInstallParams