HP 3000 Manuals

Micro Focus COBOL System Reference, Volume 2

Descriptions of Directives 

Descriptions for all of the Animator directives appear alphabetically.
Each description contains the following entries.

Key 


            

The syntax of the Animator directives is shown using diagrams called
"railroad tracks", in which a directive and its parameters are shown
+oined by lines indicating the order in which they should be written.
You read these diagrams left-to-right.  Each diagram starts with '' and
ends with '".  Sometimes the track forks to show alternatives and then
joins up again.  The length of a track has no significance.

Parameters for directives are shown in quotation marks, although
parentheses can be used instead, unless otherwise stated.  When quotation
marks are used the parameter can contain spaces, whereas no spaces are
allowed in a parameter surrounded by parentheses.

On UNIX environments, the optional slash is not required and should not
be used.  Instead of enclosing the parameter to a directive in quotes, it
can follow an equals sign following the directive.  For example:

FLASH=ZOOM.

Parameters:.   

Lists and describes valid parameter(s), if any, for the directive.

Default:.   

Indicates the directive's default setting.

Environment:.   

Specifies the environments in which this directive can be used.

Remarks:.   

Contains any additional information about the directive.

8BITCHAR 

This directive is maintained for compatibility with older products on
UNIX. It has no effect in this system and will be removed in a future
release.

Syntax:.   


            

Parameters:.   

None

Default:.   

NO8BITCHAR

Environment:.   

All

Remarks:.   

This directive is included for compatibility with older products on UNIX.
It is not required with this product.

BREAK 

Sets a breakpoint at the specified paragraph or section.

Syntax:.   


            

Parameters:.   

 proc-name          Name of a paragraph or section in the program being
                    animated.

Default:.   

NOBREAK

Environment:.   

All

BREAKPOINTS 

Specifies the number of breakpoints that can be set in any one program.

Syntax:.   


            

Parameters:.   

 integer            Integer between 4 and 100 defining the number of
                    breakpoints allowed.

Default:.   

BREAKPOINTS"100"

Environment:.   

All

Remarks:.   

Only 12 bytes are allocated for each breakpoint you allow for, so you
need only change this value if you are very short of memory.

With cross-session or cooperative animation, the number of breakpoints
allowed defaults to four and cannot be changed.

COBAIF 

Specifies whether to load and save Animator session information.

Syntax:.   


            

Parameters:.   

 path-name          The location of the Animator information file.

Default:.   

COBAIF"idy-path"

Environment:.   

All

Remarks:.   

The Animator information file contains details of breakpoints and
monitors.  Its extension is .aif.

If no COBAIF directive is specified, the default behavior is to save and
load the information files in the directory where the .idy file is found.

If NOCOBAIF is specified, no information files are loaded or saved.

If COBAIF is specified with no path-name, the information files are saved
and loaded in the directory specified by the COBAIF environment variable.
If the COBAIF environment variable does not exist, then the current
directory is used.

If COBAIF is specified with path-name, the information files are saved
and loaded from the directory specified.

END 

Indicates the end of directives to Animator and start of command line
parameters to your program.

Syntax:.   


            

Parameters:.   

None

Default:.   

Not present

Environment:.   

All

Remarks:.   

This directive can be followed by text for use in ACCEPT...FROM
COMMAND-LINE.

FILECASE 

Controls whether or not Animator converts file-names to upper case for
use in internal comparisons.

Syntax:.   


            

Parameters:.   

None

Default:.   

NOFILECASE (on UNIX) FILECASE (on DOS, Windows and OS/2)

Environment:.   

All

FLASH 

Sets the default condition under which Animator will automatically
display the user screen.

Syntax:.   


            

Parameters:.   

 mode               The mode in which Animator will display the user
                    screen.

Default:.   

FLASH"ZOOM"

Environment:.   

All

Remarks:.   

The possible values of mode are:

STEP                Display user screen before executing each statement.

ZOOM                Display user screen before zooming.

The setting can be altered from within Animator.

Using FLASH, you can make Animator display the user screen before it
calls a subprogram written in another language.  This will prevent the
subprogram's output overwriting the Animator screen.

FLASH-CALLS 

Makes Animator display the user screen at every CALL statement and
whenever a PERFORM statement is stepped over.

Syntax:.   


            

Parameters:.   

None

Default:.   

NOFLASH-CALLS

Environment:.   

All

Remarks:.   

This should be used when the program being animated makes calls to
non-COBOL programs that write to the screen; for example, OS/2 VIO API
function calls.

HIGHLIGHT 

Specifies whether or not to highlight the line that Animator is currently
on.

Syntax:.   


            

Parameters:.   

None

Default:.   

HIGHLIGHT

Environment:.   

All

HOLDVIEW 

With cross-session animation, specifies how long the user screen is
displayed before returning to Animator.

Syntax:.   


            

Parameters:.   

 integer            The length of time, in seconds.

Default:.   

HOLDVIEW"4"

Environment:.   

DOS, Windows and OS/2

Remarks:.   

HOLDVIEW with no parameter specifies an infinite time.  In this case, any
keystroke causes control to be returned to Animator.  If specified,
integer indicates the number of seconds before control is automatically
returned to Animator.

HOLDVIEW is needed when the user program is running in a different
session, as Animator no longer has control and cannot detect keystrokes
in the user session.

PRELOADIDY 

Specifies whether to load and save Animator session information.

Syntax:.   


            

Parameters:.   

None

Default:.   

PRELOADIDY

Environment:.   

DOS, Windows and OS/2

Remarks:.   

This directive is for compatibility with earlier versions of this
product.  Its behavior can be achieved by using the COBAIF directive.

See also:.   

COBAIF

RESEQ 

Makes COBOL line sequence numbers appear on Animator's display of the
source.

Syntax:.   


            

Parameters:.   

None

Default:.   

RESEQ

Environment:.   

All

Remarks:.   

Do not use RESEQ if the program contains ++INCLUDE or - INC statements.

SCREENPAGE 

Causes the screen to page up or down when you scroll or Step to a line of
code not currently displayed on the screen.

Syntax:.   


          Syntax 

Parameters:.   

None

Default:.   

NOSCREENPAGE (DOS, Windows and OS/2) SCREENPAGE (UNIX)

Environment:.   

All

Remarks:.   

If this directive is not set, you can scroll or Step continuously through
your source code.

If this directive is set, the current line appears as either the third
line from the top of the next screen or the third line from the bottom of
the previous screen.

USER-MACHINE 

With cooperative animation, specifies the machine where the user program
will run.

Syntax:.   


          Syntax 

Parameters:.   

 netname            Network name.  An alphanumeric string of up to eight
                    characters.

Default:.   

NOUSER-MACHINE

Environment:.   

DOS, Windows and OS/2

Remarks:.   

Animator and the cooperative program Animuser communicate using a network
name, netname.  The default network name is COOPANIM. If more than one
cooperative animation is likely to take place on the same network at the
same time, each must use a different network name.  In this case you must
specify a unique name with this directive when starting Animator and
Animuser.

USER-SESSION 

With cross session animation, specifies the session to be used for the
user program.

Syntax:.   


          Syntax 

Parameters:.   

 session            The session to use for the user program.

Default:.   

USER-SESSION"CURRENT"

Environment:.   

OS/2

Remarks:.   

The possible values of session are:

CURRENT             Same session as Animator.

FULL-SCREEN         Separate OS/2 full screen session.

PM                  As a Presentation Manager application.

WINDOWED            Separate OS/2 windowed session.

If the selected session is not "current" and NOUSER-MACHINE is specified
(or default), this directive makes Animator start a cross-session
animation.  If USER-MACHINE is specified, this directive specifies the
session to be activated on the user machine.  For any session other than
"current" the user machine must be running OS/2.

In all cases, the user program is started by Animator.  If it is running
in a different session, then the session is also started by Animator.

With USER-SESSION"PM" the default for HOLDVIEW is HOLDVIEW"4".

See also:.   

HOLDVIEW Animator directive

ZOOM 

Invokes Animator in zoom mode

Syntax:.   

*********************************************************

************ Original figure not available **************

*********************************************************

          Figure D-1.  Syntax 

Parameters:.   

 program-name       Zoom until this subprogram is entered.

Default:.   

NOZOOM

Environment:.   

All

Remarks:.   

In zoom mode, Animator executes the program at full speed, displaying the
user screen rather than the source code.

MPE/iX 5.0 Documentation