DUMP Verb - BBj

For this topic's original documentation, see the DUMP Verb.

BBj-Specific Information

In BBj, the DUMP verb will not return individual fields in template records, just the complete templated string.

Syntax

DUMP {(channelno{,MODE=options}{,ERR=lineref})}

Description

In BBj 15.00 and above, MODE=options can be specified to select specific categories of information to be displayed. If no options are specified, the DUMP format is unchanged from previous versions of BBj.

In BBj 20.20 and above, the DUMP verb includes the values of all BBj Custom Object fields. If a BBj Custom Object contains a toDump() method, the DUMP verb also includes the value returned by that method.

Parameter

Description

channelno

Output channel number.

MODE=options

Comma-separated list of one or more of the following options:

Option

Description

all

Report all information historically included in the DUMP output.

arrays

Dump arrays.

channels

Print open channels, similar to the _fids utility.
chunk=int In BBj 21 and higher, this specifies the number of bytes to show on each row of a hex dump of a string value. The default is chunk=20.

clientenv

Print client environment variables.
cols=int In BBj 21 and higher, this specifies the maximum output columns for non-console output. For console output, this is always set to the current console columns.
dumptostring In BBj 22.02 and higher, this specifies that the Custom Object toString and toDump values should be shown in hex dump format instead of the default plain text format.

env

Print client and server environment variables.

forloops

Print active FOR..NEXT loops.

globalnamespace

Dump global namespace keys and values.

globalvars

Dump STBL variables.

groupnamespace

Dump group namespace keys and values.

gosubs

Print active GOSUBs.

intarrays

Dump integer arrays.

intvars

Dump integer variables.

numarrays

Dump numeric arrays.

numvars

Dump numeric variables.

objarrays

Dump object arrays.

objecttable

Dump BBjObjectTable keys and values

objvars

Dump object variables.

repeatloops

Print active REPEAT..UNTIL loops.

retry

Print current retry address (last error).

serverenv

Print server environment variables.

sqlchannels

Print open SQL channels.

stackinfo

Print all active loop and control structures.

strarrays

Dump string arrays.

strvars

Dump string variables

system

Report various system variables.

vars

Dump variables.

whileloops

Print active WHILE..WEND loops.

level=int

Dump only the specified program level or levels.  To dump selected levels, specify "level=1,level=3". The level number can be specified as defined by TCB(13), or as -1 or -2 as defined by the PGM() function.

name=value

Dump only the specified variable name or names.

value=value

In BBj 20 and higher, dump only the specified value or values.

mask=pattern

In BBj 20 and higher, dump only the specified mask pattern or patterns.

ERR=lineref

Branch to be taken if an error occurs during execution.

Examples

>DUMP (0,MODE="CHANNELS")

1040 DUMP (0,MODE="NAME=X$,NAME=I")

See Also

Verbs - Alphabetical Listing