Arguments

 

stream

   OpenVMS usage:longword_unsigned
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference
   Stream number specifying the stream to which the message refers.
   The stream argument is the address of a longword containing the
   number of the stream to which the message refers.
 

request

   OpenVMS usage:identifier
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference
   Request code identifying the request being completed. The request
   argument is the address of a longword containing the code that
   identifies the request that has been completed.

   The code usually corresponds to the code the job controller
   passed to the symbiont by means of a call to SMB$READ_MESSAGE.
   But the symbiont can also initiate task-completion and task-
   status messages that are not in response to a request. (See the
   Description help topic.)
 

accounting

   OpenVMS usage:char_string
   type:         character string
   access:       read only
   mechanism:    by descriptor
   Accounting information about a task. The accounting argument
   is the address of a descriptor pointing to the accounting
   information about a task. Note that this structure is passed
   by descriptor and not by reference.

   The job controller accumulates task statistics into a job-
   accounting record, which it writes to the accounting file when
   the job is completed.

   The following diagram depicts the contents of the 16-byte
   structure:

   31                                                  0
   -----------------------------------------------------
            Number of pages printed for the job
   -----------------------------------------------------
             Number of reads from disk or tape
   -----------------------------------------------------
          Number of writes to the printing device
   -----------------------------------------------------
                          Unused
   -----------------------------------------------------
 

checkpoint

   OpenVMS usage:char_string
   type:         character string
   access:       read only
   mechanism:    by descriptor
   Checkpoint data about the currently executing task. The
   checkpoint argument is the address of the descriptor that points
   to checkpointing information that relates to the status of
   a task. When the symbiont sends this information to the job
   controller, the job controller saves it in the queue database.
   When a restart-from-checkpoint request is executed for the queue,
   the job controller retrieves the checkpointing information from
   the queue database and sends it to the symbiont in the SMBMSG$K_
   CHECKPOINT_DATA item that accompanies a SMBMSG$K_START_TASK
   request.

   Print symbionts can use the checkpointing information to
   reposition the input file to the point corresponding to the page
   being output when the last checkpoint was taken. Other symbionts
   might use checkpoint information to specify restart information
   for partially completed tasks.

                                  NOTE

      Because each checkpoint causes information to be written
      into the job controller's queue database, taking a
      checkpoint incurs significant overhead. Use caution in
      regard to the size and frequency of checkpoints. When
      determining how often to checkpoint, weigh processor and
      file-system overhead against the convenience of restarting.
 

device_status

   OpenVMS usage:longword_unsigned
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference
   Status of the device served by the symbiont. The device_
   status argument is the address of a longword passed to the job
   controller, which contains the status of the device to which the
   symbiont is connected.

   This longword contains a longword bit vector, each bit of which
   specifies device-status information. Each programming language
   provides an appropriate mechanism for defining these device-
   status bits. The following table describes each bit:

   Device Status Bit    Description

   SMBMSG$V_LOWERCASE   The device to which the symbiont is
                        connected supports lowercase characters.
   SMBMSG$V_PAUSE_      The symbiont sends this message to inform
   TASK                 the job controller that the symbiont has
                        paused on its own initiative.
   SMBMSG$V_REMOTE      The device is connected to the symbiont by
                        means of a modem.
   SMBMSG$V_SERVER      The symbiont is not connected to a device.
   SMBMSG$V_STALLED     Symbiont processing is temporarily stalled.
   SMBMSG$V_STOP_       The symbiont requests that the job
   STREAM               controller stop the queue.
   SMBMSG$V_TERMINAL    The symbiont is connected to a terminal.
   SMBMSG$V_            The device to which the symbiont is
   UNAVAILABLE          connected is not available.
 

error

   OpenVMS usage:vector_longword_unsigned
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference
   Condition codes returned by the requested task. The error
   argument is the address of a vector of longword condition codes.
   The first longword contains the number of longwords following it.

   If the low bit of the first condition code is clear, the job
   controller aborts further processing of the job. Output of
   any remaining files, copies of files, or copies of the job is
   canceled. In addition, the job controller saves up to three
   condition values in the queue database. The first condition value
   is included in the job-accounting record that is written to the
   system's accounting file (SYS$MANAGER:ACCOUNTNG.DAT).