zlogdictionary
zlogdictionary
DICTIONARY

The zlogdictionary statement outputs a data dictionary to the instrumentation log (if instrumentation is enabled).

Parameters

This statement has one parameter:

dictionary – dictionary to output to log.

Description

This statement outputs a data dictionary to the instrumentation log, but only if instrumentation is enabled. If instrumentation is not currently enabled for this procedure, the zlog statement does nothing. See Debug Instrumentation to learn how to configure instruments.

The zlog statement has one parameter, a formula for the dictionary to be sent to the log. For example, the code:

    zlogdictionary windowinfo("","ALL")

will put something like this into the log:

    [Test] == DICTIONARY windowinfo("","ALL") ============
    [Test] DATABASE="Formula Workshop"
    [Test] HORIZONTALSCROLLBAR=0
    [Test] VARIABLES="
    [Test] theWizardFormula
    [Test] resultFormat
    [Test] theWizardFormulaResult
    [Test] theWizardFormulaError
    [Test] theFormulaDatabase"
    [Test] OPTIONS="NoToolBar NoHorzScroll NoVertScroll"
    [Test] VERTICALSCROLLBAR=0
    [Test] TOOLBAR=0
    [Test] TYPE="Form"
    [Test] LASTTIMEINFRONT=3673970363
    [Test] NAME="Formula Workshop"
    [Test] PROCEDURE=""
    [Test] FORM="Formula"
    [Test] === END OF DICTIONARY windowinfo("","ALL") ============

The parameter must be just a dictionary, you cannot mix in anything else.

Remember, you can keep zlogdictionary statements in your code permanently. They only output to the log if instrumentation is enabled, which can be done on a procedure-by-procedure basis. So when you aren’t interested in the log output, you can simply turn off instrumentation (see Debug Instrumentation) instead of manually removing all the zlogdictionary statements. If you need them again later, they can be enabled in an instant.

See Also

- Client/Server Debug Instrumentation -- using instrumentation with Panorama X server and clients.
- Debug Instrumentation -- conditional logging of the internal state of Panorama program code.
- info("runningunderterminal") -- returns true if Panorama was launched under Terminal.app.
- labelize( -- returns the value of a field or variable along with a label. This saves typing when you need to display fields or variables when logging and debugging.
- labelizeformula( -- returns the value of a formula along with the formula itself as a label.
- labelizeinfo( -- returns the value of an info( function, along with the function itself as a label.
- labelizepattern( -- formats a text value using a label and a pattern.
- zlog -- outputs a message to the instrumentation log (if instrumentation is enabled).
- zlogalways -- unconditionally outputs a message to the instrumentation log.
- zlogcoverage -- allows instrumentation coverage to be turned on or off within a procedure.
- zlogging( -- returns true if zlogging is enabled for the current database and procedure, otherwise false.

History

Version | Status | Notes
10.2 | New | New in this version.