IDirectSoundBuffer::GetCaps

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The IDirectSoundBuffer::GetCapsmethod retrieves the capabilities of the DirectSoundBuffer object.

HRESULT GetCaps(
LPDSBCAPS
lpDSBufferCaps
);

Parameters

lpDSBufferCaps

Address of a DSBCAPSstructure to contain the capabilities of this sound buffer.

Return Values

If the method succeeds, the return value is DS_OK.

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

Remarks

The DSBCAPSstructure contains similar information to the DSBUFFERDESCstructure passed to the IDirectSound::CreateSoundBuffermethod, with some additional information. This additional information can include the buffer's location, either in hardware or software, and some cost measures. Examples of cost measures include the time it takes to download to a hardware buffer and the processing overhead required to mix and play the buffer when it is in the system memory.

The flags specified in the dwFlagsmember of the DSBCAPSstructure are the same flags used by the DSBUFFERDESCstructure. The only difference is that in the DSBCAPSstructure, either DSBCAPS_LOCHARDWARE or DSBCAPS_LOCSOFTWARE will be specified according to the location of the buffer memory. In the DSBUFFERDESCstructure, these flags are optional and, depending on which flag is specified, force the buffer to be located in either hardware or software.

Requirements

Runs On	Versions	Defined in	Include	Link to
Windows CE OS	2.12 or later. Version 2.12 requires DXPAK 1.0 or later.	dsound.h		dsound.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.