|
|
|
Programmatically executes the MPE/iX command SPOOLF
spool_id;PRINT.
Syntax
REC REC REC
AIFSPFLINK ( overall_status, source_spf, linked_spf_id,
REC REC I32 I32
linked_spf_ufid, target_device, priority, copies,
I32 I32 CA I32
spsave, defer, spf_lockword, user_id );
Parameters
- overall_status
- record by reference (required)
Returns the overall status of the call. A zero indicates a successful
call. A negative value indicates an error in the overall call. A
positive value indicates a warning. Refer to appendix A for meanings of
status values.
Record type: status_type (Refer to appendix B.)
- source_spf
- record by reference (required)
Passes the name of the spool file to be copied and linked.
Record type: filename_type (Refer to appendix B.)
- linked_spf_id
- record by reference (optional)
Returns the spool file ID of the spool file created and linked to the
HPSPOOL account.
Record type: spf_id_type (Refer to appendix B.)
Default: nil
- linked_spf_ufid
- record by reference (optional)
Returns the UFID of the spool file created and linked to the
HPSPOOL account.
Record type: ufid_type (Refer to appendix B.)
Default: nil
- target_device
- Record by reference (optional)
Passes the device name used as the new target device for printing the
spool file. Whether this parameter is specified or not, the spool file
queue for the device must be open, or an error results. The device name
should be left-justified and padded with blanks.
Array type: device_name_type (Refer to appendix B.)
Default: nil
- priority
- 32-bit signed integer by value (optional)
Passes the output priority of the newly created spool file in the
HPSPOOL account. The valid range is 0..13.
Default: 8
- copies
- 32-bit signed integer by value (optional)
Passes the number of copies to be printed for the newly created spool
file in the HPSPOOL account. The valid range is 1..65535.
Default: 1
- spsave
- 32-bit signed integer by value (optional)
Passes the SPSAVE flag setting for the newly created spool file in the
HPSPOOL account. The SPSAVE flag directs the spooler
to save the spool file in the HPSPOOL account after it has been
printed. The default is not to save the spool file. The values are as
follows:
Default: 0
- defer
- 32-bit signed integer by value (optional)
Passes the file state of newly created spool file. If defer is specified,
the spool file is not printed. The default is not to defer the printing
of the spool file. The values are as follows:
Default: 0
- spf_lockword
- character array by reference (optional)
Passes the lockword for spool file specified in
source_spf.
Array type: pac16 (Refer to appendix B.)
Default: nil
- user_id
- 32-bit signed integer by value (optional)
The user ID assigned to a vendor at the time of purchase of the
Architected Interface Facility: Operating System product. If it is not
passed, the caller must have previously called AIFACCESSON.
Default: 0
Operation Notes
Spool files under the native mode spooler are permanent disk files. They are
created implicitly by sending data to a spooled output device. Spool files can
be created explicitly by using the HPFOPEN intrinsic or the
BUILD command.
A spool file created by HPFOPEN with the link option or the linked
device option resides in the HPSPOOL account. It has an entry in the
separately maintained spool file directory and is linked into the spool file
queues. This is called a "linked" spool file and it is known to the spooling
processes.
A spool file created by the BUILD command or by the HPFOPEN
intrinsic without the link option can reside in any user directory. It does
not have an entry in the spool file directory and is not linked into the spool
file queues. A spool file created in such a manner is described as "unlinked"
and is not known to the spooling processes. To clarify this further, A linked
spool file must reside in the HPSPOOL account, but a spool file that
resides in the HPSPOOL account is not necessarily linked.
To link a spool file for printing, the spool file must first be copied to the
HPSPOOL account and linked into the spool file directory.
AIFSPFLINK provides both the copying and the linking as described.
AIFSPFLINK works for both a linked or an unlinked spool file, but if
a spool file is already linked, it is not necessary to call AIFSPFLINK
to get extra copies of the spool file printed.
One other application of AIFSPFLINK is that a user may save a copy of
a spool file from the HPSPOOL account in his own directory. This can
be achieved by the COPY command. The user copy of the spool file is
not linked. Later on, when this spool file is to be printed, the user can call
AIFSPFLINK to copy and link the spool file to the HPSPOOL
account. However, the spool file queue must be open for the target device
before a copy of the spool file can be created in the OUT group of
the HPSPOOL account.
Certain attributes of a spool file can be altered while linking the spool file
by calling this routine. If the target device information exists in the file
label extension, then that device will be used as the default. The
target_device parameter may be specified to override the
existing target device. If there is no target device in the file label
extension, target_device must be specified when calling
AIFSPFLINK or an error results.
If a lockword exists for the file specified in source_spf, it
must be specified in the parameter spf_lockword. Other
attributes that can be changed for the spool files are priority, copies,
spsave and defer.
|
