IDirectSoundBuffer::Initialize

Article
06/03/2016

[The feature associated with this page, DirectSound, is a legacy feature. It has been superseded by WASAPI and Audio Graphs. Media Casting have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of DirectSound, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

This method initializes a DirectSoundBuffer object if it has not yet been initialized.

Syntax

HRESULT Initialize( LPDIRECTSOUND lpDirectSound, LPCDSBUFFERDESC lpcDSBufferDesc );

Parameters

lpDirectSound
Address of the DirectSound object associated with this DirectSoundBuffer object.
lpcDSBufferDesc
Address of a DSBUFFERDESC structure that contains the values used to initialize this sound buffer.

Return Value

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be one of the following error values.

DSERR_INVALIDPARAM

DSERR_ALREADYINITIALIZED

Remarks

Because the IDirectSound::CreateSoundBuffer method calls IDirectSoundBuffer::Initialize internally, it is not needed for the current release of DirectSound. This method is provided for future extensibility.

Requirements

Header: Declared in DSound.h.

Library: Use Dsound.lib.