prf_$queue_file

PRF_$QUEUE_FILE                   Domain/OS                    PRF_$QUEUE_FILE


NAME
     prf_$queue_file - queue a print request

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/prf.h>

     void prf_$queue_file(
          char *pathname,
          short &pathname_length,
          char *queue,
          short *queue_length,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/prf.ins.pas';

     procedure prf_$queue_pathname(
          in pathname: univ name_$pname_t;
          in pathname_length: integer;
          out queue: name_$pname_t;
          out queue_length: integer;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'

           integer*2 pathname_length, queue_length
           integer*4 status
           character pathname*1024, queue*1024

           call prf_$queue_file(pathname, pathname_length, queue,
          &                     queue_length, status)

DESCRIPTION
     This call queues a print request for the file at pathname.  It does not
     copy the file at pathname to the print spool, so the print server will
     delete the original file itself rather than a spooled copy when the print
     job completes unless the DELETE option is set to OFF.  When
     prf_$queue_file returns, it supplies the pathname of the queued print
     request in queue.

     pathname
          The pathname of the file to print.

     pathname_length
          The number of bytes in pathname.

     queue
          The pathname of the queued print request.

     queue_length
          The number of bytes in queue.

     status
          The completion status.

NOTES
     Both prf_$name_print and prf_$queue_file queue a print reqest, and thus
     initiate a print job to print a file.  The difference between them is
     that prf_$name_print copies the file to a print spool and the resulting
     print request prints from the spooled copy.  Consequently, when the print
     job terminates and the print server deletes the file indicated by the
     print request, it is the spooled copy that is deleted - not the original
     file named in the prf_$name_print call.  Prf_$queue_file doesn't copy the
     file to a print spool, so when the print job terminates and the print
     server deletes the file indicated by the print request, the original file
     named in the prf_$queue_file call is deleted.

     Therefore, while setting DELETE OFF for a print request queued by
     prf_$queue_file is a good safety precaution for preserving the original
     file, setting DELETE OFF for a print request queued by prf_$name_print
     will leave orphaned files on the print spool and is not generally a good
     idea.

SEE ALSO
     prf_$stream_print.
Museum
