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


faxGetSessionStatus

Description

Returns status information during a fax send or receive operation.

Prototype

DWORD faxGetSessionStatus ( HFAX hFax,
FAX_SESSION_STATUS *ptrFaxStatus)

hFax Handle returned by TAPI.

ptrFaxStatus Pointer to the FAX_SESSION_STATUS structure that receives the document status:


typedef struct 
{
 DWORD size;
 DWORD rate; 
 DWORD ecm;    /* Error correction mode: FAX_YES or FAX_NO            */
 DWORD resolution;
 DWORD encoding;
 DWORD pagewidth;
 DWORD mode;    /* FAX_MODE_IDLE, FAX_MODE_NEGOTIATING,            */
     /* FAX_MODE_TRANSMITING, FAX_MODE_RECEIVING,  */
     /* FAX_MODE_DISCONNECTING, FAX_MODE_FINISHED            */
 DWORD error;    /* Last error code generated            */
 DWORD docnumber;
     /* Current document in progress            */
 DWORD pagenumber;
/* Current page of the document */
DWORD badlines; /* Number of bad lines (or bad frames in */ /* ECM mode) during current session */ char filename[FAX_FILENAME_MAX];
/* Name of current file processed */
char remoteSID[FAX_MAX_SID]; /* Received SID from remote station */ BYTE remoteNSF[FAX_MAX_NSF]; /* Received NSF from remote station */ } FAX_SESSION_STATUS;

Return Values

Events

Details

This function is used to return additional information about the state of the fax session at the most recent event.

The error field in the FAX_SESSION_STATUS structure may contain any of the FAXERR_xxx values.

For more information, refer to Section 7.8, Requesting Fax Session Status.

See Also

faxReceiveFax, faxSendFax



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