The IDirectinputEffect::Download method places the effect on the device. If the effect is already on the device, then the existing effect is updated to match the values set by the IDirectInputEffect::SetParameters method.
HRESULT Download(void);
Return Values
If the method succeeds, the return value is DI_OK or S_FALSE.
If the method fails, the return value may be one of the following error values:
| DIERR_NOTINITIALIZED |
| DIERR_DEVICEFULL |
| DIERR_INCOMPLETEEFFECT |
| DIERR_INPUTLOST |
| DIERR_NOTEXCLUSIVEACQUIRED |
| DIERR_INVALIDPARAM |
| DIERR_EFFECTPLAYING |
If the method returns S_FALSE, the effect has already been downloaded to the device.
Remarks
It is valid to update an effect while it is playing. The semantics of such an operation are explained in the reference for IDirectInputEffect::SetParameters.
QuickInfo
Windows NT: Use version 5.0 or later.
Windows: Use Windows 95 OSR2 or later. Available as a redistributable for Windows 95.
Windows CE: Unsupported.
Header: Declared in dinput.h.
Import Library: Use dinput.lib.