TraceDisableActivity

PowerScript function

Description

Disables logging of the specified trace activity.

Syntax

1	TraceDisableActivity ( activity )

Argument	Description
activity	A value of the enumerated datatype TraceActivity that identifies the activity for which logging should be disabled. Values are: ActError! — Occurrences of system errors and warnings ActESQL! — Embedded SQL statement entry and exit ActGarbageCollect! — Start and finish of garbage collection ActLine! — Routine line hits ActObjectCreate! — Object creation entry and exit ActObjectDestroy! — Object destruction entry and exit ActProfile! — Abbreviation for the ActRoutine!, ActESQL!, ActObjectCreate!, ActObjectDestroy!, and ActGarbageCollect! values ActRoutine! — Routine entry and exit (if this value is disabled, ActLine! is automatically disabled) ActTrace! — Abbreviation for all activities except ActLine! ActUser! — Occurrences of an activity you selected

Argument

Description

activity

A value of the enumerated datatype TraceActivity that
identifies the activity for which logging should be disabled.
Values are:

ActError! — Occurrences of system errors and
warnings
ActESQL! — Embedded SQL statement entry and
exit
ActGarbageCollect! — Start and finish of garbage
collection
ActLine! — Routine line hits
ActObjectCreate! — Object creation entry and
exit
ActObjectDestroy! — Object destruction entry and
exit
ActProfile! — Abbreviation for the ActRoutine!,
ActESQL!, ActObjectCreate!, ActObjectDestroy!, and
ActGarbageCollect! values
ActRoutine! — Routine entry and exit (if this value
is disabled, ActLine! is automatically disabled)
ActTrace! — Abbreviation for all activities except
ActLine!
ActUser! — Occurrences of an activity you
selected

Return value

ErrorReturn. Returns one of the following values:

Success! — The function succeeded
FileNotOpenError! — TraceOpen has not been called yet
TraceStartedError! — You have called TraceDisableActivity after
TraceBegin and before TraceEnd

Usage

Use this function to disable the logging of the specified trace
activities. You typically use this function if you are tracing only
portions of an application run (and thus you are calling
TraceBegin multiple times) and you want to log different activities during
each portion of the application.

Unless specifically disabled with TraceDisableActivity, activities
that were previously enabled with a call to the
TraceEnableActivity function remain enabled throughout the entire
application run.

You must always call the TraceEnd function before calling
TraceDisableActivity.

Examples

This example logs the enabled activities for the first block of code
to be traced. Then it stops logging and disables two activity types for a
second trace block. When logging is resumed for another portion of the
application run, the activities that are not specifically disabled remain
enabled until TraceClose is called:

TraceEnableActivity(ActESQL!)

TraceEnableActivity(ActGarbageCollect)

TraceEnableActivity(ActObjectCreate!)

TraceEnableActivity(ActObjectDestroy!)

TraceBegin("Trace_block_1")

TraceEnd()

TraceDisableActivity(ActESQL!)

TraceDisableActivity(ActGarbageCollect!)

TraceBegin("Trace_block_2")

See also

TraceEnd

TraceEnableActivity

Document get from Powerbuilder help

Thank you for watching.

Powerbuilder Documentation 2018

August 20, 2023

Was this article helpful?