Edit

IConfigurationDataCollector interface (pla.h)

  • Article

Collects computer settings at the time of collection. You can use the configuration information to verify the system state or track changes. PLA saves the configuration information to the file specified in the IDataCollector::FileName property. The contents of the file is XML that is consistent with the TraceRpt.exe schema.

To create this data collector, call the IDataCollectorCollection::CreateDataCollector or IDataCollectorCollection::CreateDataCollectorFromXml method. For details on the XML that you pass to CreateDataCollectorFromXml, see Remarks.

Inheritance

The IConfigurationDataCollector interface inherits from the IDataCollector interface.

Methods

The IConfigurationDataCollector interface has these methods.

 
IConfigurationDataCollector::get_FileMaxCount

Retrieves or sets the maximum number of files to collect. (Get)
IConfigurationDataCollector::get_FileMaxRecursiveDepth

Retrieves or sets the maximum number of subfolders from which to recursively collect files. (Get)
IConfigurationDataCollector::get_FileMaxTotalSize

Retrieves or sets the maximum total file size of all files combined that you can collect. (Get)
IConfigurationDataCollector::get_Files

Retrieves or sets the files to collect. (Get)
IConfigurationDataCollector::get_ManagementQueries

Retrieves or sets Windows Management Instrumentation (WMI) queries to run. (Get)
IConfigurationDataCollector::get_QueryNetworkAdapters

Retrieves or sets a value that indicates whether the installed network adapters are queried for their offloading capabilities and other configuration information. (Get)
IConfigurationDataCollector::get_RegistryKeys

Retrieves or sets a list of registry keys to collect.
IConfigurationDataCollector::get_RegistryMaxRecursiveDepth

Retrieves or sets the maximum number of subkeys from which to recursively collect registry values. (Get)
IConfigurationDataCollector::get_SystemStateFile

Retrieves or sets the name of the file that contains the saved system state. (Get)
IConfigurationDataCollector::put_FileMaxCount

Retrieves or sets the maximum number of files to collect. (Put)
IConfigurationDataCollector::put_FileMaxRecursiveDepth

Retrieves or sets the maximum number of subfolders from which to recursively collect files. (Put)
IConfigurationDataCollector::put_FileMaxTotalSize

Retrieves or sets the maximum total file size of all files combined that you can collect. (Put)
IConfigurationDataCollector::put_Files

Retrieves or sets the files to collect. (Put)
IConfigurationDataCollector::put_ManagementQueries

Retrieves or sets Windows Management Instrumentation (WMI) queries to run. (Put)
IConfigurationDataCollector::put_QueryNetworkAdapters

Retrieves or sets a value that indicates whether the installed network adapters are queried for their offloading capabilities and other configuration information. (Put)
IConfigurationDataCollector::put_RegistryKeys

Retrieves or sets a list of registry keys to collect. (Put)
IConfigurationDataCollector::put_RegistryMaxRecursiveDepth

Retrieves or sets the maximum number of subkeys from which to recursively collect registry values. (Put)
IConfigurationDataCollector::put_SystemStateFile

Retrieves or sets the name of the file that contains the saved system state. (Put)

Remarks

The following example shows the XML that you can use to initialize this object if you call CreateDataCollectorFromXml to create it. The IDataCollector::Xml property also returns this XML.

<ConfigurationDataCollector>
    <FileMaxCount/>  
    <FileMaxRecursiveDepth/>  
    <FileMaxTotalSize/>  
    <File/>  <!-- Specify this element for each file -->
    <ManagementQuery/>  <!-- Specify this element for each WMI query -->
    <QueryNetworkAdapters/>
    <RegistryKey/>  <!-- Specify this element for each registry key -->
    <RegistryMaxRecursiveDepth/>
    <SystemStateFile/>  
</ConfigurationDataCollector>

Note that the example does not show the property elements inherited from IDataCollector that you also need to specify.

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

See also

IDataCollector