&CMDLINE

The &CMDLINE verb writes the supplied text into your OCS command input line.

This verb has the following format:

&CMDLINE command_text

The &CMDLINE verb gives you the ability to put command text from within an NCL procedure into the command input line of your OCS window. Any command text is written and the cursor positioned on any location within that text.

The verb is used to prompt for operator input. A default command text is put directly into the command line for immediate entry or modification before entry. These features are used to simplify operator responses.

Operands:

command_text

Specifies any uppercase and lowercase text to place in the operator command entry line. The text starts from the second position after the &CMDLINE keyword and leading blanks are preserved. If the specified text exceeds the length of the command entry line it is truncated. Any text currently in the command entry line is erased when the &CMDLINE statement is executed.

The cursor is positioned at any location within the text by the including an underscore (_) at the point where the cursor is required. Only the first occurrence of an underscore is interpreted. If an underscore is not specified or lies outside the current command entry line boundary, the cursor is positioned at the end of the text.

Examples: &CMDLINE

&CMDLINE INACT &NODE

&CMDLINE INTQ ID=&ZNCLID DATA=_CONTINUE

Notes:

&CMDLINE generates a standard message.

The underscore character does not take up a character position within the displayed text (it is deleted before display).

&CMDLINE can be used in a procedure executing under a Remote Operator Facility region. The text returned to the OCS command line is automatically prefixed with a ROUTE command to the remote system.

If used within a procedure that is not executing under OCS (for example, system level NCL processes or NCL processes executed in a dependent processing environment), the owning environment receives the message.

A procedure can use the &ZOCS system variable to determine whether it is running under an OCS environment.