Microsoft DirectX 9.0

IDirectMusicPortDownload8::Download

The Download method downloads a waveform or instrument definition to the port. The memory must first be allocated by using the IDirectMusicPortDownload8::AllocateBuffer method.

Syntax

HRESULT Download(
  IDirectMusicDownload* pIDMDownload
);

Parameters

pIDMDownload

Address of the IDirectMusicDownload8 interface for the buffer.

Return Values

Return values are determined by the implementation of the port.

If the method succeeds, it returns S_OK.

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

Return code
E_POINTER
E_FAIL
DMUS_E_ALREADY_DOWNLOADED
DMUS_E_BADARTICULATION
DMUS_E_BADINSTRUMENT
DMUS_E_BADOFFSETTABLE
DMUS_E_BADWAVE
DMUS_E_BADWAVELINK
DMUS_E_BUFFERNOTSET
DMUS_E_NOARTICULATION
DMUS_E_NOTMONO
DMUS_E_NOTPCM
DMUS_E_UNKNOWNDOWNLOAD

Remarks

For more information on how to prepare the data to be downloaded, see Low-Level DLS.

After the memory has been downloaded, you cannot do anything more with it. To update the download, you must create a new buffer and assign it a new download ID obtained by using the IDirectMusicPortDownload8::GetDLId method, and then send it down.

Requirements

  Header: Declared in dmusicc.h.

See Also