IApiTracingDataCollector interface (pla.h)
Logs Win32 calls to Kernel32.dll, Advapi32.dll, Gdi32.dll, and User32.dll. Note that for security reasons, not all function calls are logged.
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 IApiTracingDataCollector interface inherits from the IDataCollector interface.
Methods
The IApiTracingDataCollector interface has these methods.
| IApiTracingDataCollector::get_ExcludeApis Retrieves or sets the list of functions to exclude from the trace. (Get) |
| IApiTracingDataCollector::get_ExePath Retrieves or sets the path to the executable file whose API calls you want to trace. (Get) |
| IApiTracingDataCollector::get_IncludeApis Retrieves or sets the list of functions to include in the trace. (Get) |
| IApiTracingDataCollector::get_IncludeModules Retrieves or sets the list of modules to include in the trace. (Get) |
| IApiTracingDataCollector::get_LogApiNamesOnly Retrieves or sets a value that indicates whether PLA logs only the function name. (Get) |
| IApiTracingDataCollector::get_LogApisRecursively Retrieves or sets a value that indicates whether API tracing logs calls that are imported directly by the application. (Get) |
| IApiTracingDataCollector::get_LogFilePath Retrieves or sets the name of the log file that contains the API trace data. (Get) |
| IApiTracingDataCollector::put_ExcludeApis Retrieves or sets the list of functions to exclude from the trace. (Put) |
| IApiTracingDataCollector::put_ExePath Retrieves or sets the path to the executable file whose API calls you want to trace. (Put) |
| IApiTracingDataCollector::put_IncludeApis Retrieves or sets the list of functions to include in the trace. (Put) |
| IApiTracingDataCollector::put_IncludeModules Retrieves or sets the list of modules to include in the trace. (Put) |
| IApiTracingDataCollector::put_LogApiNamesOnly Retrieves or sets a value that indicates whether PLA logs only the function name. (Put) |
| IApiTracingDataCollector::put_LogApisRecursively Retrieves or sets a value that indicates whether API tracing logs calls that are imported directly by the application. (Put) |
| IApiTracingDataCollector::put_LogFilePath Retrieves or sets the name of the log file that contains the API trace data. (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.
<ApiTracingDataCollector>
<ExcludeApis/>
<ExePath/>
<IncludeApis/>
<IncludeModules/>
<LogApiNamesOnly/>
<LogApisRecursively/>
<LogFilePath/>
</ApiTracingDataCollector>
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 |