Table of Contents Index NMS Glossary Previous Page Next Page (Page 13 of 15 in this chapter) Version


faxResetQueue

Description

Resets all flags in a queue to mark all documents as unsent.

Prototype

DWORD faxResetQueue ( HFAX hFax,
FAX_QUEUE_HANDLE hQueue)

hFax Handle returned by NMS TAPI.

hQueue Identifies which queue to reset.

Return Values

Events

Details

Each document in a queue is flagged as sent when it is successfully sent. If a problem occurs during transmission, the entire queue may be resubmitted and only unflagged documents will be sent.

Calling faxResetQueue resets all flags so that all documents in the specified queue can be resent. This function is typically used in broadcast applications, which 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.

For more information, refer to Section 7.6.5, Resetting a Document Queue.

See Also

faxCreateQueue, faxDestroyQueue, faxEnqueueDoc



Table of Contents Index NMS Glossary Previous Page Next Page (Page 13 of 15 in this chapter) Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.