Microsoft DirectX 8.1 (C++)

IDirectMusicSegment8::GetGraph

The GetGraph method retrieves the segment's toolgraph.

Syntax

HRESULT GetGraph(
  IDirectMusicGraph** ppGraph
);

Parameters

ppGraph

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

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

If there is no graph in the segment, the method returns DMUS_E_NOT_FOUND.

The reference count of the toolgraph is incremented.

The segment object implements IDirectMusicGraph directly This interface is used primarily to call the IDirectMusicGraph8::StampPMsg method directly on the segment. This has nothing to do with a graph object that might be embedded in the segment. If you want to access an embedded object, you are accessing a different IDirectMusicGraph interface because it is an interface on the embedded graph object, not the segment itself. To obtain an interface to an embedded audiopath, use the IDirectMusicAudioPath8::GetObjectInPath or IDirectMusicSegmentState8::GetObjectInPath method.

Requirements

  Header: Declared in dmusici.h.

See Also