IDataCollector::put_FileName method (pla.h)

Retrieves or sets the base name of the file that will contain the data collector data.

This property is read/write.

Syntax

HRESULT put_FileName(
  BSTR name
);

Parameters

name

Return value

None

Remarks

The actual file name used could be different if you specified formatting options in the IDataCollector::FileNameFormat property. The IDataCollector::LatestOutputLocation property contains the actual file name used.

Do not include the path in the file name; the IDataCollectorSet::RootPath and IDataCollectorSet::Subdirectory properties determine the path to the file.

The file name extension that you specify depends on the type of data collector. The following table shows the correct extension to use for each data collector. If you specify a different extension, PLA will use it. If you do not specify an extension, PLA adds the correct extension to the file.

Data collector type Extension to use
Configuration data collectors .xml
Performance data collectors Can be .blg, .csv, or .tsv depending on the value of the IPerformanceCounterDataCollector::LogFileFormat property.
Trace data collectors .etl
 

The IDataCollector::LogAppend and IDataCollector::LogOverwrite properties determine the action taken if the file already exists.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header pla.h
DLL Pla.dll

See also

IDataCollector

IDataCollector::FileNameFormat

IDataCollector::FileNameFormatPattern