IDirectMusicPort8::Compact

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicPort8::Compact

The Compact method instructs the port to compact DLS or wave-table memory, thus making the largest possible contiguous chunk of memory available for new instruments to be downloaded.

Syntax

HRESULT Compact();  

Parameters

None.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method can return one of the error values shown in the following table.

Return code
E_FAIL
E_INVALIDARG
E_NOTIMPL
E_OUTOFMEMORY

Remarks

This method affects only DLS devices that need to manage their own DLS wavetable memory. On ports that do not manage their own memory (such as software synthesizers or hardware synthesizers that use host system memory), the method returns E_NOTIMPL.

Requirements

  Header: Declared in dmusicc.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.