IGetAppTrackerData::GetTrackerDataAsCollectionObject method (comsvcs.h)

Article
10/13/2021

Retrieves tracking data for all COM+ applications in the form of a collection object.

Syntax

HRESULT GetTrackerDataAsCollectionObject(
  [out] IUnknown **TopLevelCollection
);

Parameters

[out] TopLevelCollection

On return, the IUnknown interface for a collection of tracker data.

Return value

This method can return the standard return values E_INVALIDARG, E_OUTOFMEMORY, and S_OK.

Remarks

This method is primarily intended to enable applications that subscribe to the IComTrackingInfoEvents event interface to add support for IGetAppTrackerData with minimal changes to their code. The object returned by this method is identical to the object sent in calls to subscribers' IComTrackingInfoEvent::OnNewTrackingInfo method, so that code for navigating and parsing this collection may be reused.

Applications should not expect this method to return newly updated tracking data any more frequently than the server's suggested polling interval (see IGetAppTrackerData::GetSuggestedPollingInterval).

Note that the collection object returned by this method does not contain all tracking data that is available by calling the other methods. In particular, recycling details and hang monitoring configuration are not provided.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2 [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	comsvcs.h