IDirectSoundBuffer::GetStatus

The IDirectSoundBuffer::GetStatus method retrieves the current status of the sound buffer.

HRESULT GetStatus(
  LPDWORD lpdwStatus  
);

Parameters

lpdwStatus

Address of a variable to contain the status of the sound buffer. The status can be a combination of the following flags:

DSBSTATUS_BUFFERLOST

The buffer is lost and must be restored before it can be played or locked.

DSBSTATUS_LOOPING

The buffer is being looped. If this value is not set, the buffer will stop when it reaches the end of the sound data. Note that if this value is set, the buffer must also be playing.

DSBSTATUS_PLAYING

The buffer is playing. If this value is not set, the buffer is stopped.

DSBSTATUS_LOCSOFTWARE

The buffer is playing in software. This flag can only be set for buffers created with DSBCAPS_LOCDEFER flag set.

DSBSTATUS_LOCHARDWARE

The buffer is playing in hardware. This flag can only be set for buffers created with DSBCAPS_LOCDEFER flag set.

DSBSTATUS_TERMINATED

The buffer was prematurely terminated by the voice management logic. Note that that if this value is set, the buffer is not playing. This flag can only be set for buffers created with DSBCAPS_LOCDEFER flag set.

Return Values

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be DSERR_INVALIDPARAM.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dsound.h.
  Import Library: Use dsound.lib.

See Also

IDirectSoundBuffer