Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetFullTopology
Collapse the table of content
Expand the table of content

IMFMediaSession::GetFullTopology method

Gets a topology from the Media Session.

This method can get the current topology or a queued topology.

Syntax


HRESULT GetFullTopology(
  [in]  DWORD       dwGetFullTopologyFlags,
  [in]  TOPOID      TopoId,
  [out] IMFTopology **ppFullTopo
);

Parameters

dwGetFullTopologyFlags [in]

Bitwise OR of zero or more flags from the MFSESSION_GETFULLTOPOLOGY_FLAGS enumeration.

TopoId [in]

The identifier of the topology. This parameter is ignored if the dwGetFullTopologyFlags parameter contains the MFSESSION_GETFULLTOPOLOGY_CURRENT flag. To get the identifier of a topology, call IMFTopology::GetTopologyID.

ppFullTopo [out]

Receives a pointer to the IMFTopology interface of the topology. The caller must release the interface.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return codeDescription
S_OK

The method succeeded.

MF_E_SHUTDOWN

The Media Session has been shut down.

 

Remarks

If the MFSESSION_GETFULLTOPOLOGY_CURRENT flag is specified in the dwGetFullTopologyFlags parameter, the method returns the topology for the current presentation. Otherwise, the method searches all of the queued topologies for one that matches the identifier given in the TopoId parameter.

This method can be used to retrieve the topology for the current presentation or any pending presentations. It cannot be used to retrieve a topology that has already ended.

The topology returned in ppFullTopo is a full topology, not a partial topology.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Mfidl.h

Library

Mfuuid.lib

See also

IMFMediaSession
TOPOID

 

 

Community Additions

ADD
Show:
© 2015 Microsoft