(Page 8 of 15 in this chapter) Version


nfxGetDocStatus

Description

Returns status of a document in the specified queue.

Prototype

DWORD nfxGetDocStatus ( CTAHD ctahd,
NFX_QUEUE_HANDLE queue_handle,
DWORD doc_number,
NFX_DOC_STATUS *ptr_doc_status)

ctahd CTA context handle returned by ctaCreateContext.

queue_handle Identifies the queue that holds the specified document.

doc_number Number of the document for which to retrieve status.

ptr_doc_status Pointer to the following structure that receives the document status:

typedef struct 
{
 DWORD size;
 DWORD docnum;       /* Entry number in queue          */
 DWORD processedstatus;    /* Has this document been sent?             */
       /* NFX_NO, NFX_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 rec'ved; */ /* or, in ECM, bad frames txed/rxed */ DWORD doctime; /* time document processing started */ DWORD duration; /* seconds elapsed processing doc */ char filename[NFX_FILENAME_MAX]; /* filename arg from nfxEnqueueDoc */ } NFX_DOC_STATUS;

Return Values

Events

Details

The NFX_DOC_STATUS structure gets updated after a document has been processed (NFXEVN_DOC_END). 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 NFX_DOC_STATUS structure may contain any of the CTAERR or NFXERR values. Refer to Appendix B for a complete listing of error codes.

See Also

nfxEnqueueDoc



(Page 8 of 15 in this chapter) Version


tech_support@nmss.com
Copyright © 1999, Natural MicroSystems, Inc. All rights reserved.