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


faxGetDocStatus

Description

Returns the status of a document in the specified queue.

Prototype

DWORD faxGetDocStatus ( HFAX hFax,
FAX_QUEUE_HANDLE hQueue,
DWORD docnumber,
FAX_DOC_STATUS *ptrDocStatus)

hFax Handle returned by TAPI.

hQueue Identifies the queue that holds the specified document.

docnumber Number of the document to retrieve status about.

ptrDocStatus Pointer to the FAX_DOC_STATUS structure that receives the document status:

typedef struct 
{
 DWORD size;
 DWORD docnum;       /* Entry number in queue          */
 DWORD processedstatus;    /* Has this document been sent?             */
       /* FAX_NO, FAX_YES, or error          */
 DWORD lasterror;      /* Last error code (if any) for doc          */
 DWORD pagecount;       /* Number of pages (for receive)          */
 DWORD startpage;      /* Page to start at (for retransmit)          */
 DWORD lastpagesent;      /* Last page # successfully sent          */
 DWORD retranscount;      /* Number of retries          */
 DWORD docencoding;      /* 1D (MH) or 2D (MR) or MMR          */
 DWORD docresolution;       /* Resolution: low, high, superhigh          */
 DWORD docwidth;      /* Width: A4, A3, B4          */
 DWORD negotiatedencoding;
/* Encoding used for transfer */
DWORD negotiatedrate; /* Baud rate used for transfer */ DWORD negotiatedresolution;
/* Resolution used for transfer */
DWORD negotiatedwidth; /* Page width used for transfer */ DWORD badlinecount; /* Number of bad lines in doc rcvd; */ /* or, in ECM, bad frames txed/rxed */ DWORD doctime; /* Time document processing started */ DWORD duration; /* Seconds elapsed processing doc */ char filename[FAX_FILENAME_MAX]; /* Filename arg from faxEnqueueDoc */ } FAX_DOC_STATUS;

Return Values

Events

Details

The FAX_DOC_STATUS structure gets updated after a document has been processed (FAXMSG_DOC_DONE). The processedstatus field indicates whether the document has been processed. If the processedstatus field has been set, the other fields in this structure contain information on the status of the document.

The lasterror field in the FAX_DOC_STATUS structure may contain any of the ERROR_xxx values.

See Also

faxEnqueueDoc



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