HP OpenVMS System Services Reference Manual
Previous Contents Index

If specified, the AST routine executes at the same access mode as the caller of $SNDJBC.

astprm


OpenVMS usage: user_arg
type: longword (unsigned)
access: read only
mechanism: by value

AST parameter to be passed to the AST service routine specified by the astadr argument. The astprm argument is this longword parameter. Function Codes This section describes the various function codes that are applicable to the $SNDJBC system service.

SJC$_ABORT_JOB

Aborts the execution of the current job from an output execution queue or the job you specified from a batch queue. By default, the job is deleted. However, for a restartable job, you can requeue it to the same queue or to another queue.

You must specify one of the following input value item codes:

SJC$_ENTRY_NUMBER
SJC$_QUEUE

You must specify the following input value item code for batch jobs:

SJC$_ENTRY_NUMBER

You can specify the following optional input value or Boolean item codes:
SJC$_DESTINATION_QUEUE ---
SJC$_HOLD SJC$_NO_HOLD
SJC$_PRIORITY ---
SJC$_REQUEUE ---

SJC$_ADD_FILE

Adds a file to the open job owned by the requesting process. You use this operation as part of a sequence of calls to the $SNDJBC service to create a job with one or more files. The first call in the sequence specifies the SJC$_CREATE_JOB operation to create an open job. Each subsequent SJC$_ADD_FILE request associates an additional file with the job. Finally, you make an SJC$_CLOSE_JOB request to complete the batch or print job specification.

To create a job that contains only one file, you can make a single call to $SNDJBC that specifies the SJC$_ENTER_FILE function code.

You must specify one of the following input value item codes:

SJC$_FILE_IDENTIFICATION
SJC$_FILE_SPECIFICATION

You can specify the following input value or Boolean item codes:
SJC$_DELETE_FILE SJC$_NO_DELETE_FILE
SJC$_DOUBLE_SPACE SJC$_NO_DOUBLE_SPACE
SJC$_FILE_BURST SJC$_NO_FILE_BURST
SJC$_FILE_COPIES ---
SJC$_FILE_FLAG SJC$_NO_FILE_FLAG
SJC$_FILE_SETUP_MODULES SJC$_NO_FILE_SETUP_MODULES
SJC$_FILE_TRAILER SJC$_NO_FILE_TRAILER
SJC$_FIRST_PAGE SJC$_NO_FIRST_PAGE
SJC$_LAST_PAGE SJC$_NO_LAST_PAGE
SJC$_PAGE_HEADER SJC$_NO_PAGE_HEADER
SJC$_PAGINATE SJC$_NO_PAGINATE
SJC$_PASSALL SJC$_NO_PASSALL

SJC$_ALTER_JOB

Alters the parameters of an existing job that is not currently executing.

You must specify the following input value item code:

SJC$_ENTRY_NUMBER

You can specify the following input value or Boolean item codes:
SJC$_AFTER_TIME SJC$_NO_AFTER_TIME
SJC$_CHARACTERISTIC_NAME SJC$_NO_CHARACTERISTICS
SJC$_CHARACTERISTIC_NUMBER ---
--- SJC$_NO_CHECKPOINT_DATA
SJC$_CLI SJC$_NO_CLI
SJC$_CPU_LIMIT SJC$_NO_CPU_LIMIT
--- SJC$_NO_DELETE_FILE
SJC$_DESTINATION_QUEUE ---
SJC$_DOUBLE_SPACE SJC$_NO_DOUBLE_SPACE
SJC$_FILE_BURST SJC$_NO_FILE_BURST
SJC$_FILE_COPIES ---
SJC$_FILE_FLAG SJC$_NO_FILE_FLAG
SJC$_FILE_SETUP_MODULES SJC$_NO_FILE_SETUP_MODULES
SJC$_FILE_TRAILER SJC$_NO_FILE_TRAILER
SJC$_FIRST_PAGE SJC$_NO_FIRST_PAGE
SJC$_FORM_NAME ---
SJC$_FORM_NUMBER ---
SJC$_HOLD SJC$_NO_HOLD
SJC$_JOB_COPIES ---
SJC$_JOB_DEFAULT_RETAIN ---
SJC$_JOB_ERROR_RETAIN ---
SJC$_JOB_NAME ---
SJC$_JOB_RETAIN ---
SJC$_JOB_RETAIN_TIME ---
SJC$_LAST_PAGE SJC$_NO_LAST_PAGE
SJC$_LOG_DELETE SJC$_NO_LOG_DELETE
SJC$_LOG_QUEUE ---
SJC$_LOG_SPECIFICATION SJC$_NO_LOG_SPECIFICATION
SJC$_LOG_SPOOL SJC$_NO_LOG_SPOOL
SJC$_LOWERCASE SJC$_NO_LOWERCASE
SJC$_NOTE SJC$_NO_NOTE
SJC$_NOTIFY SJC$_NO_NOTIFY
SJC$_OPERATOR_REQUEST SJC$_NO_OPERATOR_REQUEST
SJC$_PAGE_HEADER SJC$_NO_PAGE_HEADER
SJC$_PAGINATE SJC$_NO_PAGINATE
SJC$_PARAMETER_1 through 8 SJC$_NO_PARAMETERS
SJC$_PASSALL SJC$_NO_PASSALL
SJC$_PRIORITY ---
SJC$_QUEUE ---
SJC$_RAD SJC$_NO_RAD
SJC$_RESTART SJC$_NO_RESTART
SJC$_WSDEFAULT SJC$_NO_WSDEFAULT
SJC$_WSEXTENT SJC$_NO_WSEXTENT
SJC$_WSQUOTA SJC$_NO_WSQUOTA

If you specify the SJC$_QUEUE item code, the $SNDJBC service verifies that the selected job entry exists on the specified queue before modifying the job.

SJC$_ALTER_QUEUE

Alters the parameters of a queue. The execution of current jobs is unaffected.

You must specify the following input value item code:

SJC$_QUEUE

You can specify the following input value or Boolean item codes:
SJC$_BASE_PRIORITY ---
SJC$_CHARACTERISTIC_NAME SJC$_NO_CHARACTERISTICS
SJC$_CHARACTERISTIC_NUMBER ---
SJC$_CLOSE_QUEUE ---
SJC$_CPU_DEFAULT SJC$_NO_CPU_DEFAULT
SJC$_CPU_LIMIT SJC$_NO_CPU_LIMIT
SJC$_DEFAULT_FORM_NAME ---
SJC$_DEFAULT_FORM_NUMBER ---
SJC$_FILE_BURST SJC$_NO_FILE_BURST
SJC$_FILE_BURST_ONE ---
SJC$_FILE_FLAG SJC$_NO_FILE_FLAG
SJC$_FILE_FLAG_ONE ---
SJC$_FILE_TRAILER SJC$_NO_FILE_TRAILER
SJC$_FILE_TRAILER_ONE ---
SJC$_FORM_NAME ---
SJC$_FORM_NUMBER ---
SJC$_GENERIC_SELECTION SJC$_NO_GENERIC_SELECTION
SJC$_JOB_BURST SJC$_NO_JOB_BURST
SJC$_JOB_FLAG SJC$_NO_JOB_FLAG
SJC$_JOB_LIMIT ---
SJC$_JOB_RESET_MODULES SJC$_NO_JOB_RESET_MODULES
SJC$_JOB_SIZE_MAXIMUM SJC$_NO_JOB_SIZE_MAXIMUM
SJC$_JOB_SIZE_MINIMUM SJC$_NO_JOB_SIZE_MINIMUM
SJC$_JOB_SIZE_SCHEDULING SJC$_NO_JOB_SIZE_SCHEDULING
SJC$_JOB_TRAILER SJC$_NO_JOB_TRAILER
SJC$_OPEN_QUEUE ---
SJC$_OWNER_UIC ---
SJC$_PAGINATE SJC$_NO_PAGINATE
SJC$_PROTECTION ---
SJC$_QUEUE_DESCRIPTION SJC$_NO_QUEUE_DESCRIPTION
SJC$_RAD SJC$_NO_RAD
SJC$_RECORD_BLOCKING SJC$_NO_RECORD_BLOCKING
SJC$_RETAIN_ALL_JOBS SJC$_NO_RETAIN_JOBS
SJC$_RETAIN_ERROR_JOBS ---
SJC$_SWAP SJC$_NO_SWAP
SJC$_WSDEFAULT SJC$_NO_WSDEFAULT
SJC$_WSEXTENT SJC$_NO_WSEXTENT
SJC$_WSQUOTA SJC$_NO_WSQUOTA

SJC$_ASSIGN_QUEUE

Assigns a logical queue to an execution queue. The SJC$_QUEUE item code specifies the logical queue; the SJC$_DESTINATION_QUEUE item code specifies the execution queue.

You must specify the following input value item codes:

SJC$_DESTINATION_QUEUE
SJC$_QUEUE

SJC$_BATCH_CHECKPOINT

Establishes a checkpoint in a batch job. No operation is performed if the requesting process is not a batch process.

You must specify the following input value item code:

SJC$_CHECKPOINT_DATA

SJC$_CLOSE_DELETE

Deletes the open job owned by the requesting process. No item codes are allowed.

SJC$_CLOSE_JOB

Completes the specification of the open job owned by the requesting process and places the job in the queue specified in the SJC$_CREATE_JOB request that opened the job. If the SJC$_CLOSE_JOB request completes successfully, the job is no longer an open job; it becomes a normal batch or print job.

You can specify the following output value item code:

SJC$_JOB_STATUS_OUTPUT

SJC$_CREATE_JOB

Creates an open job for the requesting process. If the process already owns an open job, that job is deleted.

An open job is a batch or print job that has not yet been completely specified. After you make the SJC$_CREATE_JOB request to open the job, you can make subsequent calls to $SNDJBC using the SJC$_ADD_FILE function code to specify the files associated with the job. Finally, you can complete the job specification with an SJC$_CLOSE_JOB request. If the SJC$_CREATE_JOB operation completes successfully, the open job created is given an entry number; the job is not assigned to the queue specified in the SJC$_CREATE_JOB operation until the SJC$_CLOSE_JOB request completes successfully.

You must specify the following input value item code:

SJC$_QUEUE

You can specify the following input value or Boolean item codes:
SJC$_ACCOUNT_NAME ---
SJC$_AFTER_TIME SJC$_NO_AFTER_TIME
SJC$_CHARACTERISTIC_NAME SJC$_NO_CHARACTERISTICS
SJC$_CHARACTERISTIC_NUMBER ---
SJC$_CLI SJC$_NO_CLI
SJC$_CPU_LIMIT SJC$_NO_CPU_LIMIT
SJC$_FILE_BURST SJC$_NO_FILE_BURST
SJC$_FILE_BURST_ONE ---
SJC$_FILE_FLAG SJC$_NO_FILE_FLAG
SJC$_FILE_FLAG_ONE ---
SJC$_FILE_TRAILER SJC$_NO_FILE_TRAILER
SJC$_FILE_TRAILER_ONE ---
SJC$_FIRST_PAGE SJC$_NO_FIRST_PAGE
SJC$_FORM_NAME ---
SJC$_FORM_NUMBER ---
SJC$_HOLD SJC$_NO_HOLD
SJC$_JOB_COPIES ---
SJC$_JOB_DEFAULT_RETAIN ---
SJC$_JOB_ERROR_RETAIN ---
SJC$_JOB_NAME ---
SJC$_JOB_RETAIN ---
SJC$_JOB_RETAIN_TIME ---
SJC$_LAST_PAGE SJC$_NO_LAST_PAGE
SJC$_LOG_DELETE SJC$_NO_LOG_DELETE
SJC$_LOG_QUEUE ---
SJC$_LOG_SPECIFICATION SJC$_NO_LOG_SPECIFICATION
SJC$_LOG_SPOOL SJC$_NO_LOG_SPOOL
SJC$_LOWERCASE SJC$_NO_LOWERCASE
SJC$_NOTE SJC$_NO_NOTE
SJC$_NOTIFY SJC$_NO_NOTIFY
SJC$_OPERATOR_REQUEST SJC$_NO_OPERATOR_REQUEST
SJC$_PARAMETER_1 through 8 SJC$_NO_PARAMETERS
SJC$_PRIORITY ---
SJC$_RAD SJC$_NO_RAD
SJC$_RESTART SJC$_NO_RESTART
SJC$_UIC ---
SJC$_USERNAME ---
SJC$_WSDEFAULT SJC$_NO_WSDEFAULT
SJC$_WSEXTENT SJC$_NO_WSEXTENT
SJC$_WSQUOTA SJC$_NO_WSQUOTA

You can specify the following output value item code:

SJC$_ENTRY_NUMBER_OUTPUT

SJC$_CREATE_QUEUE

Creates a queue. If the queue already exists and is not stopped, this request performs no operation. However, if the queue already exists and is stopped, the request alters the parameters of the queue based on the item codes specified in the request; if you specify the SJC$_CREATE_START item code, the request starts the queue.

You must specify the following input value item code:

SJC$_QUEUE

You can specify the following input value or Boolean item codes:
SJC$_AUTOSTART_ON ---
SJC$_BASE_PRIORITY ---
SJC$_BATCH SJC$_NO_BATCH
SJC$_CHARACTERISTIC_NAME SJC$_NO_CHARACTERISTICS
SJC$_CHARACTERISTIC_NUMBER ---
SJC$_CLOSE_QUEUE ---
SJC$_CPU_DEFAULT SJC$_NO_CPU_DEFAULT
SJC$_CPU_LIMIT SJC$_NO_CPU_LIMIT
SJC$_CREATE_START ---
SJC$_DEFAULT_FORM_NAME ---
SJC$_DEFAULT_FORM_NUMBER ---
SJC$_DEVICE_NAME ---
SJC$_FILE_BURST SJC$_NO_FILE_BURST
SJC$_FILE_BURST_ONE ---
SJC$_FILE_FLAG SJC$_NO_FILE_FLAG
SJC$_FILE_FLAG_ONE ---
SJC$_FILE_TRAILER SJC$_NO_FILE_TRAILER
SJC$_FILE_TRAILER_ONE ---
SJC$_FORM_NAME ---
SJC$_FORM_NUMBER ---
SJC$_GENERIC_QUEUE SJC$_NO_GENERIC_QUEUE
SJC$_GENERIC_SELECTION SJC$_NO_GENERIC_SELECTION
SJC$_GENERIC_TARGET ---
SJC$_JOB_BURST SJC$_NO_JOB_BURST
SJC$_JOB_FLAG SJC$_NO_JOB_FLAG
SJC$_JOB_LIMIT ---
SJC$_JOB_RESET_MODULES SJC$_NO_JOB_RESET_MODULES
SJC$_JOB_SIZE_MAXIMUM SJC$_NO_JOB_SIZE_MAXIMUM
SJC$_JOB_SIZE_MINIMUM SJC$_NO_JOB_SIZE_MINIMUM
SJC$_JOB_SIZE_SCHEDULING SJC$_NO_JOB_SIZE_SCHEDULING
SJC$_JOB_TRAILER SJC$_NO_JOB_TRAILER
SJC$_LIBRARY_SPECIFICATION SJC$_NO_LIBRARY_SPECIFICATION
SJC$_OPEN_QUEUE ---
SJC$_OWNER_UIC ---
SJC$_PAGINATE SJC$_NO_PAGINATE
SJC$_PRINTER ---
SJC$_PROCESSOR SJC$_NO_PROCESSOR
SJC$_PROTECTION ---
SJC$_QUEUE_DESCRIPTION SJC$_NO_QUEUE_DESCRIPTION
SJC$_QUEUE_MANAGER_NAME ---
SJC$_RAD SJC$_NO_RAD
SJC$_RECORD_BLOCKING SJC$_NO_RECORD_BLOCKING
SJC$_RETAIN_ALL_JOBS SJC$_NO_RETAIN_JOBS
SJC$_RETAIN_ERROR_JOBS ---
SJC$_SCSNODE_NAME ---
SJC$_SERVER ---
SJC$_SWAP SJC$_NO_SWAP
SJC$_TERMINAL SJC$_NO_TERMINAL
SJC$_WSDEFAULT SJC$_NO_WSDEFAULT
SJC$_WSEXTENT SJC$_NO_WSEXTENT
SJC$_WSQUOTA SJC$_NO_WSQUOTA

SJC$_DEASSIGN_QUEUE

Deassigns a logical queue from an execution queue.

You must specify the following input value item code:

SJC$_QUEUE

SJC$_DEFINE_CHARACTERISTIC

Defines a characteristic name and number and inserts this definition into the queue file. The characteristic name can be up to 31 characters in length. Each characteristic name must have a unique number in the range 0 to 127. If the characteristic name is already defined, the request alters the definition of the characteristic.

A job cannot execute on an execution queue unless the queue possesses all the characteristics possessed by the job; the queue can possess additional characteristics and the job will still execute.

You must specify the following input value item codes:

SJC$_CHARACTERISTIC_NAME
SJC$_CHARACTERISTIC_NUMBER

SJC$_DEFINE_FORM

Defines a form name and number, as well as other physical attributes of the paper stock used in printers, and inserts this definition into the system job queue file. If the form name is already defined, this request alters the definition of the form.

Forms are used only by output execution queues and print jobs. A print job cannot execute unless the stock name of a form specified for the queue is the same as the stock name specified for the job. The stock name of a form, which you specify by using the SJC$_FORM_STOCK item code, specifies the paper stock used by the printer. Other item codes specify printing parameters for a job such as the margins, length of paper, and so on.

Each form must have a unique number. Numbers can range from 0 to 9999. When a new queue file is created, the system supplies the definition of a form named DEFAULT with number 0 and default characteristics.

You must specify the following input value item codes:

SJC$_FORM_NAME
SJC$_FORM_NUMBER

You can specify the following input value or Boolean item codes:
SJC$_FORM_DESCRIPTION ---
SJC$_FORM_LENGTH ---
SJC$_FORM_MARGIN_BOTTOM ---
SJC$_FORM_MARGIN_LEFT ---
SJC$_FORM_MARGIN_RIGHT ---
SJC$_FORM_MARGIN_TOP ---
SJC$_FORM_SETUP_MODULES SJC$_NO_FORM_SETUP_MODULES
SJC$_FORM_SHEET_FEED SJC$_NO_FORM_SHEET_FEED
SJC$_FORM_STOCK ---
SJC$_FORM_TRUNCATE SJC$_NO_FORM_TRUNCATE
SJC$_FORM_WIDTH ---
SJC$_FORM_WRAP SJC$_NO_FORM_WRAP
SJC$_PAGE_SETUP_MODULES SJC$_NO_PAGE_SETUP_MODULES

SJC$_DELETE_CHARACTERISTIC

Deletes the definition of a characteristic name.

Previous Next Contents Index