Previous Topic: #LINEOUT SyntaxNext Topic: #LINEOUT Status Codes


#LINEOUT Parameters

OUTLEN=

Specifies the length, in bytes, of the data stream to be written to the terminal.

output-data-length

A register that contains the length or an absolute expression of the length. Output data lengths of 0 and 1 can be used in the following situations:

LRB=

Specifies the three-fullword storage area in which the system will build the #LINEOUT parameter list

SYSPLIST

(Default); is the symbolic name of the storage area in which the system will build the line request block.

line-request-block

A register that points to the area or the symbolic name of that area in which the system will build the LRB.

OUTAREA=

Specifies the storage area that contains data to be output. OUTAREA need not be defined if OUTLEN=0 has been specified.

output-data-location

A register that points to the area or the symbolic name of the area.

OPTNS=terminal-option

Specifies several options applicable to terminal output operations. This parameter is never required and should be specified only when appropriate. The OPTNS parameter values must be enclosed in parentheses. If multiple values are specified, each is separated from the previous one by a comma.

NEWPAGE

Requests that the system write the output data line beginning on a new page. For 3270 devices, the NEWPAGE option forces the system to output all lines stored in the current buffer, even if the buffer is not full.

NOWAIT

Requests an asynchronous transfer of data; the issuing task executes concurrently with the output operation.

NOBKPG

(3270 devices only); requests the system not to keep pages that have been output in a scratch area. If NOBKPG is specified, the terminal operator can view only the current page of data. NOBKPG is valid only with the first request in a line mode session.

SAVE

Directs the system to preserve the output from the #LINEOUT in the event that an unsolicited write-direct-to-terminal data stream is received at the issuing terminal while the #LINEOUT data stream is being displayed. This option overrides the task SAVE/NOSAVE option specified during system generation.

HDR=

Specifies the number of the page header line being defined, modified, or deleted.

header-line-number

An absolute expression of the line number. If OUTLEN is other than 0 the value stored in OUTAREA will be moved to the designated (first, second, or third) header line. If a header line with the same number has been previously defined for this I/O session, the system will replace it with the value stored in OUTAREA. If OUTLEN=0, the designated header line will be deleted.

DESTID/USERID/LTERMID

Specifies a write-direct-to-terminal request. The HDR= and OPTNS=(NOWAIT/NOBKPG/NEWPAGE) parameters are ignored during a blast request.

DESTID=

Specifies a write-direct-to-terminal request (blast) to the following destinations defined during system generation:

destination-id

A register that points to the destination id, the symbolic name of a user-defined field that contains the destination ID, or the ID itself enclosed in quotation marks. The destination list can include both 3270 and TTY devices.

USERID=

Specifies a blast request to a specific signed-on user. The system will send the #LINEOUT data stream specified in the OUTAREA parameter to a specific signed-on user.

user-id

A register that points to the user id, the symbolic name of a user-defined field that contains the user ID, or the ID itself enclosed in quotation marks.

LTERMID=

(#LINEOUT only); specifies a blast request to a specific in-service terminal. The system will send the #LINEOUT data stream specified in the OUTAREA parameter to a specific in-service terminal.

logical-terminal-id

A register that points to the logical terminal id, the symbolic name of a user-defined field that contains the logical terminal ID, or the ID itself enclosed in quotation marks.

COND=

Specifies whether this #LINEOUT is conditional and under what conditions control should be returned to the issuing program.

NO

(Default); specifies that the request is not conditional.

ALL

Specifies that the request is conditional. Control is returned if the request cannot be serviced for any of the reasons listed below.

condition

Specifies conditions under which the system returns control to the issuing task. Multiple conditions must be enclosed in parentheses and separated by commas.

CANC

The line I/O session is terminated by the terminal operator pressing CLEAR (3270), ATTENTION (2741), or BREAK (teletype).

IOER

A logical or permanent I/O error is encountered in the output data stream.

INVP

There is an invalid parameter in the LRB.

UNDF

An undefined DESTID or LTERMID is specified in a #LINEOUT blast request.

CANCXIT=cancel-line-i/o-label

Specifies the symbolic name of the routine to which control should be returned if the line I/O session is terminated by the terminal operator.

IOERXIT=i/o-error-label

Specifies the symbolic name of the routine to which control should be returned if a permanent or logical I/O error is detected in the output data stream.

INVPXIT=invalid-parameter-list-label

Specifies the symbolic name of the routine to which control should be returned in the event of an invalid parameter in the LRB.

UNDFXIT=invalid-destid-ltermid-label

Specifies the symbolic name of the routine to which control should be returned if an undefined DESTID or LTERMID is specified in a #LINEOUT blast request.

ERROR=error-label

Specifies the symbolic name of the routine to which control should be returned if a condition specified in the COND parameter occurs for which no other exit routine was coded.