Share via


GetEffectStatus routine

The GetEffectStatus callback returns the device effects status.

Syntax

HRESULT GetEffectStatus(
   DWORD   dwDeviceID,
   DWORD   dwDnloadID,
   LPDWORD lpdwStatusCode
);

Parameters

  • dwDeviceID
    Indicates the external joystick number being addressed.

  • dwDnloadID
    Indicates the effect to be queried.

  • lpdwStatusCode
    Points to a value that receives the effect status. The DWORD pointed to by this parameter should be filled in with one of the following values:

    • DIEGES_PLAYING
      The effect is still playing.

    • 0
      The effect is not playing.

Return value

Returns S_OK if successful; otherwise, returns an error code.

Requirements

Target platform

Header

Dinputd.h

 

 

Send comments about this topic to Microsoft