NWCloseFileAndStartQueueJob2(3nw)

NWCloseFileAndStartQueueJob2 -- closes a queue file and marks it ready for execution

Synopsis

   #include <nwqms.h> 
   or 
   #include <nwcalls.h> 
    
   NWCCODE N_API NWCloseFileAndStartQueueJob 
     (NWCONN_HANDLE   conn, 
      nuint32         queueID, 
      nuint32         jobNumber, 
      NWFILE_HANDLE   fileHandle);

Description

The parameters are as follows:

conn: (IN) Specifies the queue server connection handle.
queueID: (IN) Specifies the bindery object ID of the queue in which the specified job was placed.
jobNumber: (IN) Specifies the job number of the job to be serviced.
fileHandle: (IN) Specifies the file handle of the job to be executed (returned by NWCreateQueueFile2).

Return values

0x0000: SUCCESSFUL
0x0006: Queue file specified by fileHandle does not exist.
0x8999: DIRECTORY_FULL
0x89D0: ERR_Q_IO_FAILURE
0x89D1: ERR_NO_QUEUE
0x89D2: ERR_NO_Q_SERVER
0x89D3: ERR_NO_Q_RIGHTS
0x89D4: ERR_QUEUE_FULL
0x89D5: ERR_NO_Q_JOB
0x89D6: ERR_NO_Q_JOB_RIGHTS
0x89D7: ERR_Q_IN_SERVICE
0x89D8: ERR_Q_NOT_ACTIVE
0x89D9: ERR_Q_STN_NOT_SERVER
0x89DA: ERR_Q_HALTED
0x89DB: ERR_Q_MAX_SERVERS
0x89FF: Failure,HARDWARE_FAILURE

Notices

jobNumber contains the job number returned by QMS when the job was originally entered in the queue.

NWCloseFileAndStartQueueJob2 closes the file associated with the job and resets QF_ENTRY_OPEN in jobControlFlags.

jobControlFlags bit definitions follow:

Bit Flag Name Description

0x08 Auto Start Specifies how to handle the job should the client station lose its connection before submitting the job. If this bit is set, the job is serviced after a queue server connection is broken, even if the client has not cleared the Entry Open bit. If the bit is cleared when a server connection is broken, QMS removes the job from the queue.

0x10 Service Restart Specifies how to handle the job if the queue server fails during processing. The job remains in the queue (in its current position) when a queue server fails. If this bit is cleared, QMS removes the job from the queue when a server fails.

0x20 Entry Open Specifies whether the job is ready to be processed. When the job entry is first created, this flag is set to indicate the job has not been submitted yet. When the client submits the job, this flag is cleared. NWCloseFileAndStartQueueJob2 clears this bit (marking the job ready for service) if the User Hold and Operator Hold bits are cleared.

0x40 User Hold Specifies whether the job may be processed. If the flag is set, the job will not be processed until the flag is clear, but the job continues to advance toward the front of the queue. An operator or the client who submitted the job can modify this flag.

0x80 Operator Hold Specifies whether the job may be processed. If the flag is set, the job will not be processed until the flag is clear, but the job continues to advance toward the front of the queue. Only operators can modify this flag.

Bit	Flag Name	Description
0x08	Auto Start	Specifies how to handle the job should the client station lose its connection before submitting the job. If this bit is set, the job is serviced after a queue server connection is broken, even if the client has not cleared the Entry Open bit. If the bit is cleared when a server connection is broken, QMS removes the job from the queue.
0x10	Service Restart	Specifies how to handle the job if the queue server fails during processing. The job remains in the queue (in its current position) when a queue server fails. If this bit is cleared, QMS removes the job from the queue when a server fails.
0x20	Entry Open	Specifies whether the job is ready to be processed. When the job entry is first created, this flag is set to indicate the job has not been submitted yet. When the client submits the job, this flag is cleared. NWCloseFileAndStartQueueJob2 clears this bit (marking the job ready for service) if the User Hold and Operator Hold bits are cleared.
0x40	User Hold	Specifies whether the job may be processed. If the flag is set, the job will not be processed until the flag is clear, but the job continues to advance toward the front of the queue. An operator or the client who submitted the job can modify this flag.
0x80	Operator Hold	Specifies whether the job may be processed. If the flag is set, the job will not be processed until the flag is clear, but the job continues to advance toward the front of the queue. Only operators can modify this flag.

 
 --------------------------------------------------------- 
| Bit |  Flag Name      |  Description                   | 
|-----|-----------------|--------------------------------| 
| 0x08|  Auto Start     |  Specifies how to handle the   | 
|     |                 |  job should the client station | 
|     |                 |  lose its connection before    | 
|     |                 |  submitting the job. If this   | 
|     |                 |  bit is set, the job is        | 
|     |                 |  serviced after a queue server | 
|     |                 |  connection is broken, even if | 
|     |                 |  the client has not cleared the| 
|     |                 |  Entry Open bit. If the bit is | 
|     |                 |  cleared when a server         | 
|     |                 |  connection is broken, QMS     | 
|     |                 |  removes the job from the      | 
|     |                 |  queue.                        | 
|-----|-----------------|--------------------------------| 
| 0x10|  Service Restart|  Specifies how to handle the   | 
|     |                 |  job if the queue server fails | 
|     |                 |  during processing. The job    | 
|     |                 |  remains in the queue (in its  | 
|     |                 |  current position) when a queue| 
|     |                 |  server fails. If this bit is  | 
|     |                 |  cleared, QMS removes the job  | 
|     |                 |  from the queue when a server  | 
|     |                 |  fails.                        | 
|-----|-----------------|--------------------------------| 
| 0x20|  Entry Open     |  Specifies whether the job is  | 
|     |                 |  ready to be processed. When   | 
|     |                 |  the job entry is first        | 
|     |                 |  created, this flag is set to  | 
|     |                 |  indicate the job has not been | 
|     |                 |  submitted yet. When the client| 
|     |                 |  submits the job, this flag is | 
|     |                 |  cleared.                      | 
|     |                 |  NWCloseFileAndStartQueueJob2  | 
|     |                 |  clears this bit (marking the  | 
|     |                 |  job ready for service) if the | 
|     |                 |  User Hold and Operator Hold   | 
|     |                 |  bits are cleared.             | 
|-----|-----------------|--------------------------------| 
| 0x40|  User Hold      |  Specifies whether the job may | 
|     |                 |  be processed. If the flag is  | 
|     |                 |  set, the job will not be      | 
|     |                 |  processed until the flag is   | 
|     |                 |  clear, but the job continues  | 
|     |                 |  to advance toward the front of| 
|     |                 |  the queue. An operator or the | 
|     |                 |  client who submitted the job  | 
|     |                 |  can modify this flag.         | 
|-----|-----------------|--------------------------------| 
| 0x80|  Operator Hold  |  Specifies whether the job may | 
|     |                 |  be processed. If the flag is  | 
|     |                 |  set, the job will not be      | 
|     |                 |  processed until the flag is   | 
|     |                 |  clear, but the job continues  | 
|     |                 |  to advance toward the front of| 
|     |                 |  the queue. Only operators can | 
|     |                 |  modify this flag.             | 
|-----|-----------------|--------------------------------|

The specified job is ready for execution when (1) NWCloseFileAndStartQueueJob2 finishes, (2) QF_USER_HOLD and QF_OPERATOR_HOLD are both cleared, and (3) targetExecutionTime in NWQueueJobStruct either has not been specified or has elapsed.

Only the workstation that created the job can call NWCloseFileAndStartQueueJob2.

Services

Queue Management

NCP calls

0x2222 23 17 Get File Server Information
0x2222 23 105 Close File And Start Queue Job (no 1000 user support)
0x2222 23 127 Close File And Start Queue Job (3.11 or later)
0x2222 66 File Close

References

NWCloseFileAndAbortQueueJob2(3nw), NWCreateQueueFile2(3nw), NWRemoveJobFromQueue2(3nw)