IDirectMusicGraph8::InsertTool
Inserts a tool in the graph.
HRESULT InsertTool(
IDirectMusicTool * pTool,
DWORD * pdwPChannels,
DWORD cPChannels,
LONG lIndex
);
Parameters
- pTool
- Tool to insert.
- pdwPChannels
- Address of an array of on which the tool accepts messages. If the tool accepts messages on all channels, pass NULL.
- cPChannels
- Count of how many channels are pointed to by pdwPChannels. Ignored if pdwPChannels is NULL.
- lIndex
- Position at which to place the tool. This is a zero-based index from the start of the current tool list or, if it is negative, from the end of the list. If lIndex is out of range, the tool is placed at the beginning or end of the list. To place a tool at the end of the list, use a number for lIndex that is larger than the number of tools in the current tool list.
Return Values
If the method succeeds, the return value is S_OK.
If it fails, the method can return one of the following error values:
Remarks
The reference count of the tool is incremented.
This method calls IDirectMusicTool8::Init.
Header: Declared in dmusici.h.