IDataCollector interface (pla.h)

Sets and retrieves collector properties using XML, specifies the log file name, and retrieves the location of the log file.

This interface is an abstract class from which the following data collectors derive:

• IAlertDataCollector
• IApiTracingDataCollector
• IConfigurationDataCollector
• IPerformanceCounterDataCollector
• ITraceDataCollector

Inheritance

The IDataCollector interface inherits from the IDispatch interface. IDataCollector also has these types of members:

Methods

The IDataCollector interface has these methods.

IDataCollector::get_DataCollectorSet Retrieves the data collector set to which this data collector belongs.
IDataCollector::get_DataCollectorType Retrieves the type of this data collector, for example, a performance data collector.
IDataCollector::get_FileName Retrieves or sets the base name of the file that will contain the data collector data. (Get)
IDataCollector::get_FileNameFormat Retrieves or sets flags that describe how to decorate the file name. (Get)
IDataCollector::get_FileNameFormatPattern Retrieves or sets the format pattern to use when decorating the file name. (Get)
IDataCollector::get_Index Retrieves the index value of the data collector. The index value identifies the data collector within the data collector set.
IDataCollector::get_LatestOutputLocation Retrieves or sets the fully decorated file name that PLA used the last time it created the file. (IDataCollector.get_LatestOutputLocation)
IDataCollector::get_LogAppend Retrieves or sets a value that indicates if PLA should append the collected data to the current file. (Get)
IDataCollector::get_LogCircular Retrieves or sets a value that indicates if PLA should create a circular file. (Get)
IDataCollector::get_LogOverwrite Retrieves or sets a value that indicates if PLA should overwrite the current file. (Get)
IDataCollector::get_Name Retrieves or sets the name of the data collector. (Get)
IDataCollector::get_OutputLocation Retrieves the decorated file name if PLA were to create it now.
IDataCollector::get_Xml Retrieves an XML string that describes the values of the data collector properties.
IDataCollector::put_FileName Retrieves or sets the base name of the file that will contain the data collector data. (Put)
IDataCollector::put_FileNameFormat Retrieves or sets flags that describe how to decorate the file name. (Put)
IDataCollector::put_FileNameFormatPattern Retrieves or sets the format pattern to use when decorating the file name. (Put)
IDataCollector::put_LatestOutputLocation Retrieves or sets the fully decorated file name that PLA used the last time it created the file. (IDataCollector.put_LatestOutputLocation)
IDataCollector::put_LogAppend Retrieves or sets a value that indicates if PLA should append the collected data to the current file. (Put)
IDataCollector::put_LogCircular Retrieves or sets a value that indicates if PLA should create a circular file. (Put)
IDataCollector::put_LogOverwrite Retrieves or sets a value that indicates if PLA should overwrite the current file. (Put)
IDataCollector::put_Name Retrieves or sets the name of the data collector. (Put)
IDataCollector::SetXml Sets the property values of those properties included in the XML. (IDataCollector.SetXml)

Remarks

The following example shows the XML that you can use to initialize this object if you call the IDataCollectorCollection::CreateDataCollectorFromXml property to create one of the derived data collectors. The IDataCollector::Xml property also returns this XML.

    <FileName/>
    <FileNameFormat/>
    <FileNameFormatPattern/>
    <Index/>
    <LatestOutputLocation/>
    <LogAppend/>
    <LogCircular/>
    <LogOverwrite/>
    <Name/>
    <OutputLocation/>

Note that the example does not show the property elements of the derived data collector (see each data collector for its XML elements). Include these elements in the data collectors XML as appropriate. The following example shows the XML for the alert data collector. You can specify the elements in any order.

<AlertDataCollector>
    <FileName/>
    <FileNameFormat/>
    <FileNameFormatPattern/>
    <Index/>
    <LatestOutputLocation/>
    <LogAppend/>
    <LogCircular/>
    <LogOverwrite/>
    <Name/>
    <OutputLocation/>
    <Alert/>  <!-- Specify an <Alert> element for each alert -->
    <EventLog/>
    <SampleInterval/>
    <Task/>
    <TaskArguments/>
    <TaskUserTextArguments/>
    <TaskSetWorkingDirectory/>
    <TriggerDataCollectorSet/>
</AlertDataCollector>

When you specify the XML to create the collector, you can specify only the elements for the properties that you want to set. If you do not specify a property, PLA provides a default value. When you retrieve the XML for the collector, the XML provides all elements, including those from IDataCollector.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	pla.h