HP 3000 Manuals

NRJEJobInfo [ SNA NRJE User/Programmer Reference Manual ] MPE/iX 5.0 Documentation


SNA NRJE User/Programmer Reference Manual

NRJEJobInfo 

Obtains a list of jobs submitted, but not transmitted to the host, and
job spool file characteristics.

Syntax 
__________________________________________________________________________
|                                                                        |
|                                                                        |
|                    BA      I      BA      I        I        IA    BA   |
|     NRJEJobInfo ( Wsid, InCount, Name, NameLen, OutCount, FileId, User,|
|                                                                        |
|                   BA        DA       IA      IA    LA     IA     IA    |
|                 JobName, JobSize, Priority, Rank, Time, State, Result  |
|                                                                        |
__________________________________________________________________________

Parameters 

             Wsid An eight-character input byte array.  The Wsid parameter identifies
                  your workstation.  It must contain a left-justified alphanumeric name
                  beginning with a letter.  If the workstation identifier is less than
                  eight characters long, it must be followed by blanks.

          InCount An input integer variable.  The InCount parameter specifies the
                  maximum number of elements (from 1 through 53) to be returned in all
                  output array parameters except Result.
             Name An input byte array.  The Name parameter specifies the kind of job
                  information you want.

                  A Name can be any of the following:

                   *  A file ID

                   *  A job name

                   *  An @ character

                   *  A UserName.AcctName 

                  Table 5-3, "Use of Name", following this intrinsic's description,
                  describes the various ways Name can be used.

          NameLen An input integer variable.  The NameLen parameter specifies the
                  number of bytes in Name, from 1 through 17.

         OutCount An output integer variable.  The OutCount parameter contains the
                  actual number of elements in all of the output arrays except Result.

                  The maximum value for OutCount is 100.

           FileId An output integer array.  The FileId array is a list of file
                  identifications of all submitted jobs that met the specification in
                  Name.

                  Each entry is an integer reference to a spool file identification.

             User An output byte array.  The User array is a list of users of all
                  submitted jobs that met the specification in Name.

                  Each entry in User corresponds to an entry in FileId.

                  Each entry is eighteen characters long, left-justified, and blank-
                  filled, in the form UserName.AcctName.  Following is an example of
                  User with three entries:

                       TYRONE.SHOELACE
                       PHILLIP.MGASTANK
                       HARDLEI.ABLE

                  At least one trailing blank is in an entry.

          JobName An output byte array.  The JobName array is a list of job names of
                  all submitted jobs that met the specification in Name.

                  Each entry in JobName corresponds to an entry in FileId.

                  Each entry is eight characters long, left-justified, and
                  blank-filled.  An example of JobName with three entries is as
                  follows:

                       FIRSTONE
                       PERRY
                       ENTE
          JobSize An output double-word integer array.  The JobSize array is a list of
                  job sizes, in sectors, of all submitted jobs that met the
                  specification in Name.

                  Each entry in JobSize corresponds to an entry in FileId.

         Priority An output integer array.  The Priority array is a list of job
                  priorities of all submitted jobs that met the specification in Name.

                  Each entry in Priority corresponds to an entry in FileId, where
                  Priority[i] is from 0 through 14; 14 is the highest priority.

             Rank An output integer array.  The Rank array is a list of job ranks in
                  the transmission queue of all submitted jobs that met the
                  specification in Name.

                  Each entry in Rank corresponds to an entry in FileId.

             Time An output logical array.  The Time array is a list of four-word
                  entries describing when a spool file was created.

                  Each entry in Time corresponds to an entry in FileId.

                  The structure of each four-word entry is as follows:

                       year 
                       day of the year 
                       hour 
                       minute 

                  where day of the year is from 1 through 366.
            State An output integer array.  The State array is a list of the spooling
                  states of each file.

                  Each entry in State corresponds to an entry in FileId.

                  The values returned in State[i] are as follows:

                  MPE V and MPE XL prior to release 2.1 

                  0 = FileId[i] is active.
                  1 = FileId[i] is ready.
                  2 = FileId[i] is opened.
                  3 = FileId[i] is locked.

                  MPE XL release 2.1 and later 

                  0 = FileId[i] is active.
                  1 = FileId[i] is ready.
                  2 = FileId[i] is opened.
                  3 = FileId[i] is deferred.
                  4 = FileId[i] is created.
                  5 = FileId[i] is being transferred.
                  6 = FileId[i] is being printed.
                  7 = FileId[i] has a problem.
                  8 = FileId[i] is delete pending.
                  9 = FileId[i] has SPSAVE specified.

                  Refer to MPE V/E System Operation and Resource Management Reference 
                  Manual (32033-90005) or the MPE XL Native Mode Spooler Reference 
                  Manual (32650-90166) for an additional discussion of spooling states.

           Result An eight-element integer output array (required).  The Result array
                  contains error codes that occurred during execution of this
                  intrinsic.

                  The first element of the Result array is set to zero if no errors
                  took place.  The structure of the Result array is described in
                  "Parameters Common to NRJE Intrinsics" in the introduction to this
                  chapter.

                  Always test the first element of Result immediately after you call
                  this intrinsic.  If the first element of Result is not zero, test the
                  other elements of Result to determine the nature of the problem that
                  has occurred.

Description 

Use NRJEJobInfo to obtain information about jobs that have been
submitted, but are not yet transmitted.  Input information to this
intrinsic is as follows:

 *  Workstation identification:  Wsid.

 *  Maximum number of elements to be returned in all output arrays except
    Result:  InCount.

 *  Job set desired:  Name and NameLen.  The structure and contents of
    Name determines the job set desired.  See Table 5-3, "Use of Name,"
    below.

Output from NRJEJobInfo consists of the following:

 *  The number of jobs qualified by Name:  OutCount.

 *  An entry in each of the output arrays, except Result, describing
    spool file characteristics.

After NRJEJobInfo has returned control to your program, test the first
element of Result.

Text Reference 

This intrinsic provides information for the SHOW command.  See Chapter 3,
"User Commands."

          Table 5-3.  Use of Name 

-------------------------------------------------------------------------------------------
|                                                                                         |
| Structure             Form                           Effect                             |
|                                                                                         |
| File identification   A five-character numeric       Information is wanted for a        |
|                       string in the form nnnnn.      submitted job with a spool file    |
|                                                      identifier of nnnnn.               |
|                                                                                         |
| Job name              An eight-character             Information is wanted for all      |
|                       alphanumeric string beginning  submitted jobs that have this job  |
|                       with a letter.                 name.                              |
|                                                                                         |
| @                     A single @ character.          Information is wanted for all jobs |
|                                                      submitted by the logon user.       |
|                                                                                         |
| Username.Acctname     A seventeen-character string   Information is wanted for all      |
|                       meeting MPE standards for      submitted jobs that have this      |
|                       UserName.AcctName.             UserName.AcctName.                 |
|                                                                                         |
|                       A period (.)  must be part of                                     |
|                       the string.                                                       |
|                                                                                         |
|                       If the UserName.AcctName is                                       |
|                       different from the logon                                          |
|                       UserName.AcctName, the logon                                      |
|                       user must be configured with                                      |
|                       NM capability.                                                    |
|                                                                                         |
-------------------------------------------------------------------------------------------



MPE/iX 5.0 Documentation