ph_traceoff PowerHome formula function
Description
Terminates a currently active tracing
session previously initiated with the ph_traceon(
) function
Syntax
ph_traceoff ( )
Return value
Integer. Returns 0 if successful.
Returns 1
if function fails
Usage
Use this function to terminate an
active
trace session that was
previously initiated with the ph_traceon( ) function. The tracing and
profiling functionality within PowerHome consists of three functions. The
ph_traceon( ) function allows you to define and start a trace session. The
ph_traceoff( ) function allows you to terminate a trace session. The
ph_tracemsg( ) function allows the user to insert a user defined message
into the
trace file.
Tracing is not something a user would typically do on
his own. The resulting trace file is not human readable and must be decoded by
the developer using the PowerBuilder development environment in which PowerHome
was written in. Tracing will usually be initiated at the developers request to
help a user track down problems or issues they may be having
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_traceoff()