Skip to content

Latest commit

 

History

History
81 lines (62 loc) · 3.89 KB

nf-pla-idatacollectorset-put_segment.md

File metadata and controls

81 lines (62 loc) · 3.89 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:pla.IDataCollectorSet.put_Segment
IDataCollectorSet::put_Segment (pla.h)
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. (Put)
IDataCollectorSet interface [PLA]
Segment property
IDataCollectorSet.Segment
IDataCollectorSet.put_Segment
IDataCollectorSet::Segment
IDataCollectorSet::get_Segment
IDataCollectorSet::put_Segment
Segment property [PLA]
Segment property [PLA]
IDataCollectorSet interface
base.idatacollectorset_get_segment
pla.idatacollectorset_get_segment
pla/IDataCollectorSet::Segment
pla/IDataCollectorSet::get_Segment
pla/IDataCollectorSet::put_Segment
put_Segment
pla\idatacollectorset_get_segment.htm
PLA
5ecac3dd-0cd1-4563-a6b3-1b98e29fe769
12/05/2018
IDataCollectorSet interface [PLA],Segment property, IDataCollectorSet.Segment, IDataCollectorSet.put_Segment, IDataCollectorSet::Segment, IDataCollectorSet::get_Segment, IDataCollectorSet::put_Segment, Segment property [PLA], Segment property [PLA],IDataCollectorSet interface, base.idatacollectorset_get_segment, pla.idatacollectorset_get_segment, pla/IDataCollectorSet::Segment, pla/IDataCollectorSet::get_Segment, pla/IDataCollectorSet::put_Segment, put_Segment
pla.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Pla.dll
Windows
19H1
IDataCollectorSet::put_Segment
pla/IDataCollectorSet::put_Segment
c++
APIRef
kbSyntax
COM
Pla.dll
IDataCollectorSet.Segment
IDataCollectorSet.get_Segment
IDataCollectorSet.put_Segment

IDataCollectorSet::put_Segment

-description

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.

-parameters

-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.

-see-also

IDataCollectorSet

IDataCollectorSet::SegmentMaxDuration

IDataCollectorSet::SegmentMaxSize