DIF_TROUBLESHOOTER

The DIF_TROUBLESHOOTER request allows an installer to start a troubleshooter for a device or to return CHM and HTM troubleshooter files for Windows to start.

Note  This DIF code is only supported on Windows Server 2003, Windows XP, and Microsoft Windows 2000.

When Sent

When a user clicks the "Troubleshooter" button for a device in Device Manager.

Who Handles

Installer Input

DeviceInfoSet
Supplies a handle to the device information set that contains the device.

DeviceInfoData
Supplies a pointer to an SP_DEVINFO_DATA structure that identifies the device in the device information set.

Device Installation Parameters
There are device installation parameters (SP_DEVINSTALL_PARAMS) associated with the DeviceInfoData.

Class Installation Parameters
An SP_TROUBLESHOOTER_PARAMS structure is associated with the DeviceInfoData.

Installer Output

Class Installation Parameters
An installer might modify the SP_TROUBLESHOOTER_PARAMS, setting a CHM or HTML file.

Installer Return Value

If a co-installer does not handle this request, it returns NO_ERROR from its preprocessing pass.

If a co-installer handles this request, it does so in its postprocessing pass. If the co-installer supplies CHM and HTML files, it propagates the status it received (probably ERROR_DI_DO_DEFAULT). If the co-installer runs a troubleshooter and fixes the problem, the co-installer returns NO_ERROR. If the co-installer runs a troubleshooter but does not fix the problem, it propagates the status it received (ERROR_DI_DO_DEFAULT).

If a class installer supplies a CHM file and an HTML file, or the class installer runs a troubleshooter but does not fix the problem, the class installer returns ERROR_DI_DO_DEFAULT. Windows will subsequently call the default handler.

If a class installer starts its own troubleshooter and fixes the problem, the class installer returns NO_ERROR. Windows will not subsequently call the default handler.

If the class installer encounters an error, the installer returns an appropriate Win32 error code. Windows will not subsequently call the default handler.

Default DIF Code Handler

None

There is no default handler for DIF_TROUBLESHOOTER, but the operating system provides default troubleshooters that attempt to resolve device problems if there are no installer-supplied troubleshooters.

Installer Operation

An installer calls CM_Get_DevNode_Status to get the device status and the CM problem code. Depending on the problem, an installer might provide a troubleshooter, a help file, or nothing. A troubleshooter can possibly resolve a problem with a device. If a troubleshooter resolves the problem, it should call SetupDiCallClassInstaller to send a DIF_PROPERTYCHANGE request of type DICS_PROPCHANGE. If an installer does not supply a troubleshooter for a device, it might supply a help file of problem-solving suggestions for the user.

If no installer runs its own troubleshooter, Windows runs HTML Help to display information to the user. If an installer supplied a CHM file in the class installation parameters, Windows displays that file. Otherwise, Windows displays system-supplied troubleshooting information.

The class installation parameters contain at most one ChmFile and HtmlTroubleShooter pair. If more than one installer specifies these values, Windows uses the values set by the last installer that handled the DIF request.

For more information about DIF codes, see Handling DIF Codes.

Requirements

See also

CM_Get_DevNode_Status

SP_DEVINFO_DATA

SP_DEVINSTALL_PARAMS

SP_TROUBLESHOOTER_PARAMS