Microsoft DirectX 8.0 (C++) |
Retrieves an instrument from a collection by its patch number.
HRESULT GetInstrument( DWORD dwPatch, IDirectMusicInstrument** ppInstrument );
If the method succeeds, the return value is S_OK.
If it fails, the method can return one of the following error values:
DMUS_E_INVALIDPATCH |
E_FAIL |
E_OUTOFMEMORY |
E_POINTER |
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.
Header: Declared in dmusicc.h.