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

faxEnqueueDoc

Description

Allocates a document entry in a document queue.

Prototype

DWORD faxEnqueueDoc ( HFAX hFax,
FAX_QUEUE_HANDLE hQueue,
char *filename,
FAX_DOC_PARMS *ptrdDocParms,
DWORD *ptrDocNumber)

hFax Handle returned by TAPI.

hQueue Identifies a valid queue to receive the new document.

filename Pointer to an existing file to send or a file to create on reception.

ptrDocParms Pointer to a FAX_DOC_PARMS structure (or NULL to use default values), as follows:

typedef struct 
{
 DWORD size;     /* Size of this structure            */
 DWORD resolution;     /* NFX_RESOLUTION_HIGH, NFX_RESOLUTION_LOW */
      /* or NFX_RESOLUTION_SUPER_HIGH            */
 DWORD encoding;     /* NFX_ENCODE_1D, NFX_ENCODE_2D or            */
      /* NFX_ENCODE_MMR            */
 DWORD pagewidth;     /* NFX_PAGE_WIDTH_A4, NFX_PAGE_WIDTH_B4 or */
      /* NFX_PAGE_WIDTH_A3             */
} FAX_DOC_PARMS;
ptrDocNumber Pointer to a location to receive a valid document number on a successful return.

Return Values

Events

Details

This function is typically used to build transmit queues or receive queues of documents before calling faxSendFax, faxReceiveFax, or faxAnswerFaxPoll. It can also be used to add documents to transmit queues or receive queues while a send or receive operation is underway.

fileName is passed as a separate argument and differs with each call to faxEnqueueDoc. The file specified by fileName enqueued to a transmit queue must exist, and must be in the correct format for transmission (TIFF-F). The file specified by fileName enqueued to a receive queue must not exist when it is enqueued.

The document number is placed in ptrDocNumber. It identifies the position of the document in the queue. The document number and the queue handle are used for subsequent calls to faxGetDocStatus.

The parameter values in FAX_DOC_PARMS can be changed with each call to faxEnqueueDoc. However, in most circumstances, these values are not likely to be changed once they are set.

For more information, refer to Section 7.5.1, Building a Document Queue.

See Also

faxCreateQueue, faxDestroyQueue


Table of Contents Index NMS Glossary Previous Page Next Page (Page 6 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.