SNAP

Purpose

Allows you to create a dump and write it to the DC/UCF log.

Syntax

►►─── SNAp ─┬─ TASk ──────────────────────────────────────────────────────┬───►
            └─ begin-debug-expression ─┬─────────────────────────────────┬┘
                                       ├─ TO end-debug-expression ───────┤
                                       └┬──────────┬─ byte-count-number ─┘
                                        └─ LENgth ─┘

 ►─┬───────────────┬──────────────────────────────────────────────────────────►◄
   └─ TITle title ─┘

Parameters

TASk

Requests a dump of all resources associated with the executing task, as well as the Task Control Element (TCE) and the Dispatch Control Element (DCE).

begin-debug-expression

Specifies the location at which to begin the snap. Begin-debug-expression can include multiple debug expressions, and it resolves to an address for which you have retrieval security.

For information on the security methods used by the debugger, see CA IDMS Security Administration Guide.

For more information on the values used in a debug expression, see Expression Components in Chapter 2, "Command Considerations."

end-debug-expression

Specifies the ending location of the display. End-debug-expression can include the same debugger entities as those specified in begin-debug-expression. The expression must resolve to a valid address for which you have retrieval security.

byte-count-number

Specifies the number of bytes to be displayed.

TITle title

Specifies an optional title for the snap. The title must be enclosed in single quotation marks ('), may not exceed 32 characters, and must be prefaced by a valid ASA carriage control character. These are the valid carriage control characters:

(Space bar)	Space one line
0	Space two lines
-	Space three lines
1	Skip to the top of the next page

The length of 32 characters includes the carriage control character. Code apostrophes in the title as two single quotation marks (''). They are counted as one character position.

When a title is not specified, a default title is written to the log.

Usage

Types and timing

You can use a SNAP command for a Task snap or a snap of specific area; the command is valid at any point in a debugger session.

You can examine the Snap dumps online with OLP (OnLine Plog), or make a hard copy by running the print log functions of the Batch Command Facility utility.

For more information see CA IDMS Utilities Guide.

Default length

When neither end-debug-expression nor byte-count-n is specified, the default length is based on these rules:

If the expression is composed of a single symbol, the data characteristics of the symbol determine the default length. The number of bytes dumped is equal to the default length of the symbol.
If the expression does not have data characteristics, the default length is 256 bytes.

Example 1

This command causes a snap to begin at the load address and terminate at @000BF050; the default title is to be used:

DEBUG >
snap $ to @bf050

The default title takes the form:

SNAP command-entered USER user-id

For example, if the user ID is MMC, the default title is:

SNAP $ TO @000BF050 USER MMC

Example 2

This command requests a snap starting at the load address for 256 bytes; the default title is to be used:

DEBUG >
snap $

Example 3

This command requests a task snap; the title IDMSTEST, positioned at the top of a display page, will be used for the dump:

DEBUG >
snap task title '1idmstest'