IDirectMusicGraph8::GetTool

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicGraph8::GetTool

The GetTool method retrieves a tool by index.

Syntax

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

Parameters

dwIndex

Zero-based index of the requested tool in the graph.

ppTool

Address of a variable that receives a pointer to the tool.

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
DMUS_E_NOT_FOUND
E_POINTER

Remarks

The application is responsible for releasing the retrieved tool.

Requirements

  Header: Declared in dmusici.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.