User Intrinsics [ SNA NRJE User/Programmer Reference Manual ] MPE/iX 5.0 Documentation
SNA NRJE User/Programmer Reference Manual
Chapter 5 User Intrinsics
Introduction
This chapter describes NRJE user intrinsics. Some of these intrinsics
have NRJE manager extensions. You must be configured with NM capability
to use the extensions to the intrinsics. Any MPE user can call these
intrinsics without the manager extensions.
All of these intrinsics are related to NRJE commands described in chapter
3, "User Commands". The manager extensions to the commands are also
indicated in this chapter.
NRJE consists of a subsystem command interface and a set of user-
callable intrinsics. An NRJE intrinsic, or a set of intrinsics,
corresponds with each subsystem command that affects job stream input or
output.
NRJE intrinsics can be called from:
* SPL
* PASCAL
* FORTRAN
* COBOL II
If you omit any parameters, you must retain the commas that follow them.
No variable length calling sequences exist.
Byte array parameters with the left-most character blank indicate that a
default value will be used.
Split-stack mode intrinsic calls are prohibited.
See Table 5-1, "NRJE User Intrinsics," for a summary. Some user
intrinsics have capabilities that can be used by NRJE managers only.
NRJE intrinsics that can be used only by NRJE managers are described in
Chapter 6, "NRJE Manager Intrinsics."
Table 5-1. NRJE User Intrinsics
------------------------------------------------------------------------------------------
| |
| Name Description |
| |
| NRJEActiveWS Provides the number and identification of active NRJE |
| workstations. |
| |
| NRJEAlter * Revises the priority of a submitted job or jobs. |
| |
| NRJECancel * Cancels previously submitted jobs not yet transmitted. |
| |
| NRJEErrMsg Obtains and writes an NRJE error message string. |
| |
| NRJEHJCancel * Cancels jobs already transmitted to the host, by marking the |
| Job Log to dispose of returning data sets. This intrinsic |
| does not apply if you are connected to a VSE/POWER host |
| system. |
| |
| NRJEHJInfo * Obtains a list of jobs transmitted to the host, the number |
| of data sets received against those jobs, and the special |
| destinations of those data sets. This intrinsic does not |
| apply if you are connected to a VSE/POWER host system. |
| |
| NRJEJobInfo * Obtains a list of jobs submitted but not transmitted to the |
| host, and job spool file characteristics. |
| |
| NRJELUList Provides a list of all LUs and related characteristics for a |
| workstation. |
| |
| NRJEQueue Obtains information about a workstation transmission queue |
| (the spooled reader). |
| |
| NRJESubmit * Prepares a batch input job stream for transmission to a host |
| system. |
| |
| NRJE2Submit * Creates a job input stream on the transmission queue to send |
| to a host system, and allows the user to specify output |
| destinations for data sets returning from the job submitted |
| to the host. If you are connected to a VSE/POWER host |
| system, the output routing capabilities are not available. |
| |
| NRJEWelcome Obtains the contents of the NRJE welcome message. |
| |
| NRJEWriter Obtains information about the logical writers configured for |
| a workstation. |
| |
| NRJEWSInfo Obtains general information about a workstation. |
| |
| * This intrinsic has NRJE manager extensions. |
| |
------------------------------------------------------------------------------------------
Parameters Common to NRJE Intrinsics
Some parameters are common to most NRJE intrinsics; each parameter is
described below.
Workstation Identification. The workstation identification (Wsid)
parameter is common to all NRJE intrinsics.
It is an eight-character input byte array. It must always begin with a
letter followed by alphanumeric characters and be left-justified with
trailing blank characters. If the workstation identifier is less than
eight characters long, it must be followed by blank characters.
Intrinsic Result. A Result parameter is common to all intrinsics. It is
an eight-element integer array. When your intrinsic call is successful,
the first element of the Result array is set to zero.
See Table 5-2 below. Also see appendix A, "Result Codes and Messages,"
in the Installing and Troubleshooting SNA NRJE manual or the SNA NRJE
Node Manager's Guide.
The elements of the Result array are as follows:
Table 5-2. Result Array Structure
-------------------------------------------------------------------------------------------
| |
| COBOL II, SPL Contents |
| FORTRAN, and Subscripting: |
| PASCAL |
| Subscripting: |
| |
| RESULT(1) RESULT(0) Intrinsic error code. |
| |
| RESULT(2) RESULT(1) File System error code. |
| |
| RESULT(3) RESULT(2) NRJE management error code. |
| |
| RESULT(4) RESULT(3) NRJE configuration error code. |
| |
| RESULT(5) RESULT(4) NRJE spooling error code. |
| |
| RESULT(6) RESULT(5) Parameter 1 associated with Intrinsic Error |
| Code. |
| |
| RESULT(7) RESULT(6) Parameter 2 associated with Intrinsic Error |
| Code. |
| |
| RESULT(8) RESULT(7) Parameter 3 associated with Intrinsic Error |
| Code. |
| |
-------------------------------------------------------------------------------------------
Stack Size
The NRJE user and manager intrinsics require 8500 words for local
variables and working space. If your program requires 9000 words for its
data stack, you should prepare your program file with a Segsize value of
17500 words. Your PREP command would look like this:
:PREP USLFILE,PROGFILE;MAXDATA=17500
You also can specify Segsize in the PREPRUN and RUN commands. You cannot
specify Segsize with any compile-and-prepare or compile-and-go commands
such as SPLPREP or SPLGO.
Intrinsic Data Types
These data types are used in intrinsic descriptions:
* BA Byte array
* D Double-word integer variable
* DA Double-word integer array
* I Integer variable (single word)
* IA Integer array
* L Logical variable (single word)
* LA Logical array
* V Value
NOTE Even numbers in logical variables and elements of logical arrays
are FALSE.
Odd numbers in logical variables and elements of logical arrays are
TRUE.
MPE/iX 5.0 Documentation