ph_tracemsg PowerHome formula function
Description
Allows the user to Insert a reference number
and message into a currently
active trace file
Syntax
ph_tracemsg ( ai_type, al_number, as_message )
| Argument | Description |
| ai_type | Integer. The type of trace message to insert. A
value of 1 inserts a traceerror message. Any other value inserts a traceuser message |
| al_number | Long. A reference number you would like to
insert in the trace file |
| as_message | String. A string message you would like to
insert in the trace file |
Return value
Integer. Returns 0
Usage
Use this function to create user
inserted messages within an active trace file. 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_tracemsg(0,999,"Start of Macro ID: TRIGGERON")