IConfigurationDataCollector::put_Files method (pla.h)

Article
02/22/2024

Retrieves or sets the files to collect.

This property is read/write.

Syntax

HRESULT put_Files(
  SAFEARRAY *Files
);

Parameters

Files

Return value

None

Remarks

You can use the IConfigurationDataCollector::FileMaxCount, IConfigurationDataCollector::FileMaxRecursiveDepth, and IConfigurationDataCollector::FileMaxTotalSize properties to limit the number of files that PLA collects.

PLA copies the files to the location specified in the IDataCollectorSet::LatestOutputLocation property. If more than one file has the same name, PLA leaves the first file name intact and appends _n (where n is a one-based serial number) to all subsequent files with the same name. You can use the XML report to determine the origin of each file.

The property performs a depth-first search using the FindFirstFile and FindNextFile functions. For example, assuming the following directory structure:

MyDir
    Subdir1
        Subdir1.1
            a.txt
            b.txt
        Subdir1.2
            c.txt
        g.txt  (folder in Subdir1)
        h.txt  (folder in Subdir1)
    Subdir 2
        subdir2.1
            y.txt
            z.txt
            subdir2.1.1
                m.txt
    q.txt  (folder in MyDir)
    s.txt  (folder in MyDir)

PLA would collect the files in the following order (assuming that no limits were reached):

q.txt
s.txt
g.txt
h.txt
a.txt
b.txt
c.txt
y.txt
z.txt
m.txt

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
DLL	Pla.dll