TraceFile object

The TraceFile object is used to access the contents of a trace file created from a PowerBuilder application. Unlike the Profiling and TraceTree objects, the TraceFile object does not provide properties and functions to create an analysis model. You use the TraceFile object in conjunction with the TraceActivityNode, TraceBeginEnd, TraceError, TraceESQL, TraceGarbageCollect, TraceLine, TraceObject, TraceRoutine, and TraceUser objects.

The TraceFile object has no events.

Properties

TraceFile property

Datatype

Description

ApplicationName

String

The name of the application used to generate the trace file.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

CollectionTime

Decimal

The amount of time (in seconds) taken by the collection of trace data. This time has already been accounted for in the timestamps from the trace file, that is, the proper amount of time has been subtracted from the timestamps before they are put in the trace file. The value is NULL if the file is not open.

LastError

ErrorReturn (enumerated)

The error code for the last error that occurred.

NumberOfActivities

Long

The number of activities that exist in the trace file.

FileName

String

The name of the opened trace file. The value is an empty string if the file is not open.


Functions

TraceFile function

Datatype returned

Description

ClassName

String

Returns the name assigned to the object.

Close

ErrorReturn (enumerated)

Closes the open trace file.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetParent

PowerObject

Returns a reference to the name of the parent object.

NextActivity

TraceActivityNode

Provides the next activity in the trace stream. If there are no more activities, or if the file is not open, an invalid object is returned. Use the LastError property to determine what kind of error occurred.

Open

ErrorReturn (enumerated)

Opens for reading the trace file with the passed name.

Reset

ErrorReturn (enumerated)

Resets the stream to the beginning of the trace file.

TypeOf

Object (enumerated)

Returns the type of the object.