This function creates a queue for either sending or receiving fax documents.
Prototype
DWORDnfxCreateQueue (CTAHD ctahd,
int queue_type, NFX_QUEUE_HANDLE *ptr_queue_handle)
ctahd Handle
returned by ctaCreateContext
queue_type
Type of document queue (either NFX_DOC_RECEIVE or NFX_DOC_TRANSMIT)
ptr_queue_handle Pointer to a location to receive a valid queue
handle on a successful return
Return Values
SUCCESS The
function completed successfully.
CTAERR_BAD_ARGUMENT
Invalid function argument passed.
CTAERR_INVALID_CTAHD The
specified CTA context handle is invalid.
CTAERR_INVALID_HANDLE The
specified document queue handle is invalid.
CTAERR_OUT_OF_MEMORY Memory
allocation failed.
NFXERR_OPEN_QUEUE_FAILED An error
occurred while accessing a document queue.
Events
None.
Details
The document queue data structure is maintained internally by NaturalFax
and a handle is returned for use with all other NaturalFax functions. Each
document queue is associated with a specified CTA context. Subsequent calls
to nfxEnqueueDoc, nfxDestroyQueue, nfxSendFax, nfxReceiveFax,
or nfxAnswerPoll will verify that the document queue is associated
with the same CTA context as the current operation.It is possible
to have many document queues associated with a given CTA context, but only
one send queue and one receive queue can be associated with an active fax
session. For example, to send multiple queues, you must call nfxSendFax
for each queue.
