Share via

3.2.4.5 IDataCollector

  • Article

The following are the properties that MUST be implemented by the objects that implement the IDataCollector interface.

Property

Read/write

Description

DataCollectorSet

R

The data collector set to which this data collector belongs.

DataCollectorType

R

The type of data collector.

FileName

RW

The base name of the file containing the output of the data collector.

FileNameFormat

RW

Determines how the name of the file storing the output of the data collector will be formatted. The FileName property itself (described above) is always included. The filename can optionally be decorated with other information. These possible decorations are specified by the AutoPathFormat enumeration. This property stores an AutoPathFormat value.

 If the AutoPathFormat value specified by this property includes the 'plaPattern' bit, the FileNameFormatPattern (specified below) contains the pattern that will be appended to the filename. The format of the pattern is specified in section 2.2.3.1.

FileNameFormatPattern

RW

If patterns are to be included in the decoration of file names, determines the pattern to use. Patterns are included in the decoration if the value of the FileNameFormat property (specified above) includes the 'plaPattern' bit. The format of the pattern is specified in section 2.2.3.1.

Index

R

The index value of the data collector.

LatestOutputLocation

RW

Full path of the file where data was stored the last time the data collector ran.

LogAppend

RW

Specifies whether existing files MUST be appended.

LogCircular

RW

Specifies whether files MUST be circular.

LogOverwrite

RW

Specifies whether existing files MUST be overwritten.

Name

RW

Name of the data collector.

OutputLocation

R

Full path of the file where data would be stored if the data collector were to start now.

Xml

R

The XML representation of the data collector set.

A data collector can be represented as an XML file, which can be used to serialize (using Xml (Get) 3.2.4.5.21) and deserialize (using SetXml 3.2.4.5.22) it. The full XML is specified in section 3.2.4.19. The format of the XML that defines a data collector, and is common to all types of data collectors, is as follows: 

     
 <DataCollectorType/>
     <FileName/> 
     <FileNameFormat/> 
     <FileNameFormatPattern/> 
     <Index/> 
     <LatestOutputLocation/> 
     <LogAppend/> 
     <LogCircular/> 
     <LogOverwrite/> 
     <Name/> 
     <OutputLocation/> 
 

Opnums 8, 28 and 31 are not used across the network. These opnums are reserved and MUST NOT be reused by non-Microsoft implementations.<17>

Methods in RPC Opnum Order

Method

Description

DataCollectorSet (Get)

Retrieves the DataCollectorSet property.

Opnum: 7

Opnum8NotUsedOnWire

Reserved for local use.

Opnum: 8

DataCollectorType (Get)

Retrieves the DataCollectorType property.

Opnum: 9

FileName (Get)

Retrieves the FileName property.

Opnum: 10

FileName (Put)

Sets the FileName property.

Opnum: 11

FileNameFormat (Get)

Retrieves the FileNameFormat property.

Opnum: 12

FileNameFormat (Put)

Sets the FileNameFormat property.

Opnum: 13

FileNameFormatPattern (Get)

 Retrieves the FileNameFormatPattern property.

Opnum: 14

FileNameFormatPattern (Put)

Sets the FileNameFormatPattern property.

Opnum: 15

LatestOutputLocation (Get)

Retrieves the LatestOutputLocation property.

Opnum: 16

LatestOutputLocation (Put)

Sets the LatestOutputLocation property.

Opnum: 17

LogAppend (Get)

Retrieves the LogAppend property.

Opnum: 18

LogAppend (Put)

Sets the LogAppend property.

Opnum: 19

LogCircular (Get)

Retrieves the LogCircular property

Opnum: 20

LogCircular (Put)

Sets the LogCircular property.

Opnum: 21

LogOverwrite (Get)

Retrieves the LogOverwrite property.

Opnum: 22

LogOverwrite (Put)

Sets the LogOverwrite property.

Opnum: 23

Name (Get)

Retrieves the Name property.

Opnum: 24

Name (Put)

Sets the Name property.

Opnum: 25

OutputLocation (Get)

Retrieves the OutputLocation property.

Opnum: 26

Index (Get)

Retrieves the Index property.

Opnum: 27

Opnum28NotUsedOnWire

Reserved for local use.

Opnum: 28

Xml (Get)

Retrieves the XML property.

Opnum: 29

SetXml

Sets the properties of the data collector using the values in the XML file.

Opnum: 30

Opnum31NotUsedOnWire

Reserved for local use.

Opnum: 31

Opnums 0, 1, and 2 are reserved for the IUnknown interface. Opnums 3, 4, 5, and 6 are reserved for the IDispatch interface.