Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- Novlib 3.30 Online Reference - <b> quefileadd()</b> http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 QueFileAdd()
------------------------------------------------------------------------------
 Purpose:
 Add a file to a queue.

 Syntax:
 iJobNum = QueFileAdd( dwQueueID, lpszPath
          ,iControl ,lpszDesc ,iCopies, iFlags ,dwServerID )

 Parameters:
 dwQueueID  The print queue ID number.
 lpszPath   The full path of the file to be printed including the volume
 name.
 iControl   The print job control flags.
 lpszDesc   The print job description.
 iCopies    The number of copies.
 iFlags     The print flags.
 dwServerID The server ID number.

 Returns:
 A numeric value (signed short int).

 The CA-Clipper name for this function is:
 QueFilAdd()

 Description:
 QueFileAdd() sends a file specified by its full path, lpszPath directly
 to a print queue, specified by its ID number dwQueueID. lpszPath must be
 the full path of the file to be printed including its volume name,
 e.g. SYS:DATA\WP\KATIE.DOC.

 iControl contains the print job control flags, represented by a numeric
 value made up from the following table:

 Keep Job if connection broken            8
 Restart Job if print server aborts it   16
 User Hold print Job                     64
 Operator Hold print Job                128

 For example to keep the print job in the event of something going wrong,
 and to place it on immediate User Hold, iControl would be specified as the
 value 8 + 64 = 72.

 lpszDesc is the print job description, which will appear as its decription
 in the PCONSOLE command line utility and on banners. lpszDesc can be up to
 47 characters in length. By default the description is the path and file
 name being printed.

 iCopies is the number of copies to print, which is typically set to 1.

 iFlags contains the print job flags, represented by a numeric value made up
 from the following table:

 Print Job if capture interrupted        4
 Automatic form feed suppressed          8
 Tabs converted to spaces               64
 Banners printed before documents      128

 For example, to stop automatic form feeds after the job has been printed
 and enable the printing of a banner before the job, iFlags would need the
 value 8 + 128 = 136.

 dwServerID is the object ID of the queue server that can service the job.
 If passed as the constant value NOVDEFLONG, any queue server may service
 the job.

 QueFileAdd() returns the queue job number, or NOVERRINT if an error occurs.

 Example:
 // To send file SYS:DATA\KATIE.DOC directly to print queue PRINTQ_1:
 if ( QueFileAdd( QueIDGet( "PRINTQ_1" ),
       "SYS:DATA\KATIE.DOC",0,"",1,0, NOVDEFLONG ) != NOVERRINT )
    ? "File SYS:DATA\KATIE.DOC has been sent directly to PRINTQ_1"
 endif

 Notes:
 QueFileAdd() uses direct network copying, which means the print job
 is copied to the queue very quickly. QueFileAdd() can only be used to send
 files that exist on the network to a network queue, it cannot print files
 that exist on a local workstation drive.

See Also: QueIDGet()

Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson