Returns status of a document in the specified queue.
DWORD nfxGetDocStatus ( CTAHD ctahd, NFX_QUEUE_HANDLE queue_handle, DWORD doc_number, NFX_DOC_STATUS *ptr_doc_status)
Argument |
Description |
ctahd |
Context handle returned by ctaCreateContext. |
queue_handle |
Identifies the queue that holds the specified document. |
doc_number |
Number of the document to retrieve status information on. |
ptr_doc_status |
Pointer to an NFX_DOC_STATUS structure (as follows) to receive the document status: typedef struct |
Return value |
Description |
SUCCESS |
|
CTAERR_BAD_ARGUMENT |
A function argument is invalid. |
CTAERR_INVALID_CTAHD |
The specified context handle is invalid. |
CTAERR_INVALID_HANDLE |
The specified document queue handle is invalid. |
None.
The NFX_DOC_STATUS structure is updated after a document is processed (NFXEVN_DOC_END). The processedstatus field indicates whether the document was processed. If the processedstatus field is set, the other fields in this structure contain information on the status of the document.
If the nfxStopSession function is called in the middle of a fax session, the value of the processedstatus field for the current document is zero.
The lasterror field in the NFX_DOC_STATUS structure can contain any of the CTAERR or NFXERR values. For more information, refer to the Alphabetical error summary.