IDirectMusicCollection8::GetInstrument

Microsoft DirectX 8.1 (C++)

IDirectMusicCollection8::GetInstrument

The GetInstrument method retrieves an instrument from a collection by its patch number.

Syntax

HRESULT GetInstrument(
  DWORD dwPatch,
  IDirectMusicInstrument** ppInstrument
);

Parameters

dwPatch

Instrument patch number.

ppInstrument

Address of a variable that receives a pointer to the IDirectMusicInstrument8 interface.

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

Remarks

The patch number passed in dwPatch describes the full patch address, including the MIDI parameters for MSB and LSB bank select. MSB is shifted left 16 bits, and LSB is shifted left 8 bits. For more information, see MIDI Channel Messages.

In addition, the high bit is set (0x80000000) if the instrument is specifically a drum kit intended to be played on MIDI channel 10.

For an example of how this method is used, see Working with Instruments.

Requirements

Header: Declared in dmusicc.h.

See Also

IDirectMusicCollection8