Resets all the flags in a queue to mark all documents as unsent.
DWORD nfxResetQueue ( CTAHD ctahd, NFX_QUEUE_HANDLE queue_handle)
|
Argument |
Description |
|
ctahd |
Context handle returned by ctaCreateContext. |
|
queue_handle |
Identifies the queue to reset. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_BAD_ARGUMENT |
A function argument is invalid. |
|
CTAERR_INVALID_CTAHD |
The specified context handle is invalid. |
|
CTAERR_INVALID_HANDLE |
The specified document queue handle is invalid. |
None.
Each document in a queue is flagged as sent when it is successfully sent. If a problem occurs during transmission, the whole queue can be resubmitted and only unflagged documents are sent.
Calling nfxResetQueue resets all flags so that all documents in the specified queue can be resent. This function is typically used in broadcast applications that send the same queue of documents on multiple phone calls.
If this function is called with a receive queue, it also changes the queue type to a transmit queue. This use is typical of a fax store-and-forward application.
Refer to Resetting a document queue for more information.