IaqCOMAccessArea Object

Applies to AQTime 8.81, last modified on May 21, 2021

Description

IaqCOMAccessArea objects provide programming interface to AQTime profiling areas. Each object corresponds to an area.

The object contains methods and properties that let you specify area attributes and append routines, source files, classes and other elements to or exclude them from the area. You can find an example of using methods and properties of IaqCOMAccessArea objects in Managing Profiling Areas via COM.

Inheritance Hierarchy

The object implements the following interfaces:

IaqCOMAccessArea

IDispatch

Members

The IaqCOMAccessArea interface declares the following methods and properties:

Members(in alphabetical order) Description
AddItem(DBGSymbol) Method. Appends the routine, class, source file or other element specified by the DBGSymbol parameter to the area. The method returns the IaqCOMAccessAreaItem object that provides access to the area’s new item.
Item(Index) Property. Read-only. Returns an IaqCOMAccessAreaItem object that provides access to the area’s item specified by its index in the area. The index is zero-based. The total number of items in the area is specified by the ItemCount property.
ItemCount Property. Read-only. Integer. Returns the number of items in the area.
Level Property. Read/write. TAreaProfileLevel.

Specifies the level of the area: routine, line or class. To specify the level, use values of the TAreaProfileLevel enumeration type (aplClasses, aplRoutines, aplLines), or the appropriate integer data.

It is impossible to convert a class-level area to a routine- or line-level area and vice versa.
Name Property. Read/write. String. Specifies the name of the area. When setting the area name, make sure it does not coincide with other areas’ names.
RetrieveParameterValues Property. Read/write. Boolean. Specifies whether the area’s Retrieve parameter values attribute is enabled. This attribute signals to the Function Trace profiler that it should trace and save parameter values of function calls to the profiling log for all functions included in the area. See Tracing Function Call Parameters and Result Values.
RemoveItem(Index) Method. Deletes the item specified by its index from the profiling area. The index is zero-based. The total number of items in the area is specified by the ItemCount property. The RemoveItem method does not return any value.
Type Property. Read/write. Specifies the area type: including or excluding. To specify the type, use the atInclude or atExclude value from the TAreaType enumeration type or appropriate integer values.

Example

For an example of using IaqCOMAccessArea objects, see Managing Profiling Areas via COM.

See Also

COM Type Reference
Managing Profiling Areas via COM
Working With AQTime via COM - Overview

Highlight search results