StartEffect routine
The StartEffect callback commands the device to play back an effect that was previously loaded.
Syntax
HRESULT StartEffect(
DWORD dwDeviceID,
DWORD dwDnloadID,
DWORD dwMode,
DWORD dwIterations
);
Parameters
dwDeviceID
Indicates the external joystick number being addressed.dwDnloadID
Indicates the effect to be played.dwMode
Specifies the playback mode. Only the following mode can be used (all other modes are reserved):- DIES_SOLO
Stop other forces that are playing and play only this one.
- DIES_SOLO
dwIterations
Specifies the number of times to perform the effect. If the value is INFINITE, then the effect should be repeated until explicitly stopped or paused.
Return value
Returns S_OK if successful; otherwise, returns an error code.