IDirectMusicGraph::GetTool

The IDirectMusicGraph::GetTool method retrieves a tool by index.

HRESULT GetTool(
  DWORD dwIndex,
  IDirectMusicTool** ppTool
);

Parameters

dwIndex: Zero-based index of the requested tool in the graph.
ppTool: Address of a variable to receive a pointer to the tool.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method may return one of the following values:

DMUS_E_NOT_FOUND

E_POINTER

Remarks

The application is responsible for releasing the retrieved tool.

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmusici.h.