IDataCollectorSet::get_Segment method (pla.h)

Article
02/22/2024

Retrieves or sets a value that indicates whether PLA creates new logs if the maximum size or segment duration is reached before the data collector set is stopped.

This property is read/write.

Syntax

HRESULT get_Segment(
  VARIANT_BOOL *segment
);

Parameters

segment

Return value

None

Remarks

You would enable segmentation, for example, if you want to write to a new log file when the current log file reaches 100 MB. The name used for the new log is determined by the IDataCollector::FileNameFormat property.

The task associated with the data collector set is launched each time a segment is created.

If VARIANT_TRUE, PLA uses both the IDataCollectorSet::SegmentMaxSize and IDataCollectorSet::SegmentMaxDuration properties, if set, to determine when to segment the log. When one of the limits is reached, PLA segments the log. After segmenting the log, PLA resets the counters for limits.

If VARIANT_FALSE, PLA ignores SegmentMaxSize and SegmentMaxDuration.

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