DirectX SDK

DirectInputEffect.Download

The DirectInputEffect.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 DirectInputEffect.SetParameters method.

object.Download()

Parameters

object
Object expression that resolves to a DirectInputEffect object.

Error Codes

If the method fails, an error is raised and Err.Number may be set to one of the following:

DIERR_NOTINITIALIZED
DIERR_DEVICEFULL
DIERR_INCOMPLETEEFFECT
DIERR_INPUTLOST
DIERR_NOTEXCLUSIVEACQUIRED
DIERR_INVALIDPARAM
DIERR_EFFECTPLAYING

Remarks

The device must be acquired at the exclusive cooperative level for this method to succeed.

It is valid to update an effect while it is playing. The semantics of such an operation are explained in the reference for DirectInputEffect.SetParameters.