Page Comparison

SYNTAX:

xpxEdmiTrace (traceFunction, traceCondition, maxTraceFileSize : INTEGER; traceFileName : STRING)
status : INTEGER;

This function is equivalent to the EDMinterface^ function edmiTrace. See EDMassist^ Volume IV for an explanation of the options.

...

traceFunction

...

One of

XPXDB_DEFINE,
XPXDB_START
XPXDB_CLOSE
DBXPX_STOP

...

traceCondition

...

Sum of:

XPXDB_CALLS
XPXDB_ARGS
XPXDB_RETURNS
XPXDB_ERRORS
XPX_DBFILE
XPXDB_RINGFILE

...

maxTraceFileSize

...

Max size of the trace file in bytes. Applicable only when the XPXDB_RINGFILE is specified.

...

traceFilename

...

Code Block

language	cpp
theme	Confluence

FUNCTION xpxEdmiTrace (traceFunction, 
                       traceCondition, maxTraceFileSize : INTEGER; 
                       traceFileName                    : STRING)
                       status                           : INTEGER;

Operates the trace facilities. The trace facilities is a powerful trace mechanism to assist users in testing and bug hunting of their application. Several filters for tracing can be defined. The resulting trace output is in plain ASCII that can be easily read and understood. Running with the trace active will normally decrease the performance of operations considerably.

Arguments

...

Type	Name	Comment
INTEGER	traceFunction	Specifies the actual EDMinterface trace operation to perform. The available operations are: XPXDEFINE_TRACE: Define EDMinterface trace conditions. XPXSTART_TRACE: Start or restart EDMinterface trace with the actual defined trace conditions. XPXSTOP_TRACE: Stop EDMinterface trace. XPXCLOSE_TRACE: Stop EDMinterface trace and close the open EDMinterface trace file.
INTEGER	traceCondition	The <traceCondition> argument is only effective when the <traceFunction> = DEFINE_TRACE. This argument can be any combination (bitwise OR) of the following. XPXTRACE_CALLS: Trace all EDMinterface function calls. The name of the EDMinterface function will be written in the trace record. XPXTRACE_ARGS: The name and value of the arguments in the EDMinterface calls will be written in the trace record. XPXTRACE_RETURNS: The name of the EDMinterface function to leave, the error status, and the return data will be written in the trace record. XPXTRACE_ERRORS: Trace all errors detected by EDMinterface functions. XPXTRACE_INTERNAL_CALLS : Trace EDMinterface functions invoked from other EDMinterface functions. XPXTRACE_LOW_LEVEL_COMMUNICATIONS: Trace all xxx XPXTRACE_TO_STDOUT: Write the trace output to the to the EDMinterface current output device. The EDMinterface current output device can be defined by the edmiDefineOutputFunction operation. XPXTRACE_TO_FILE: Write the trace output to the specified trace file, i.e. to the file specified by the <traceFile> argument. XPXTRACE_RINGFILE: The trace output file is a ring file, i.e. when the file size has reached the <maxTraceFileSize>, the file will be rewound and the trace output will start from the beginning of the file. TRACE_RINGFILE is only relevant in combination with XPXTRACE_TO_FILE and <maxTraceFileSize>is unequal zero. The header of the trace file will contain information about current write pointer, enabling the user to find the first and last line in the trace file.XPX
INTEGER	maxTraceFileSize	An integer specifying the maximum number of bytes in the <traceFile> before the file is closed or the file is rewound. This argument is only valid when <traceCondition> = XPXDEFINE_TRACE and XPXTRACE_TO_FILE is set in <traceCondition>. When XPXTRACE_RINGFILE is set in <traceCondition>, then the <traceFile> will be rewound when the file size is equal to <maxTraceFileSize>number of bytes, else the file will be closed and trace output will terminate. When <maxTraceFileSize>= 0, then no check for maximum file size will be performed.
STRING	traceFileName	Name of a file to write the trace records into. This argument is only valid for <traceFunction>=XPXDEFINE_TRACE.

Return Value

...

Insert excerpt

	US:_r_XPX_Return_Value
	US:_r_XPX_Return_Value
nopanel	true

Options

...

Example

...

Code Block

language	cpp

<Missing Example>

Versions Compared

Old Version 1

New Version Current

Key

Arguments

Return Value

Options

Example

See also