(Page 9 of 15 in this chapter) Version


nfxGetSessionStatus

Description

Returns status information during a fax send or receive operation.

Prototype

DWORD nfxGetSessionStatus ( CTAHD ctahd,
NFX_FAX_STATUS *ptr_fax_status)

ctahd CTA context handle returned by ctaCreateContext.

ptr_fax_status Pointer to an NFX_FAX_STATUS structure, as follows:


typedef struct 
{
 DWORD size;
 DWORD rate; 
 DWORD ecm;    /* error correction mode: NFX_YES or NFX_NO            */
 DWORD resolution;
 DWORD encoding;
 DWORD pagewidth;
 DWORD mode;    /* NFX_MODE_IDLE, NFX_MODE_NEGOTIATING,            */
     /* NFX_MODE_TRANSMITING, NFX_MODE_RECEIVING,   */
     /* NFX_MODE_DISCONNECTING, NFX_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[NFX_FILENAME_MAX];
/* Name of current file processed */
char remoteSID[NFX_MAX_SID]; /* Received SID from remote station */ BYTE remoteNSF[NFX_MAX_NSF]; /* Received NSF from remote station */ DWORD snr; /* signal to noise ratio in dB */ DWORD rx_training_zeros; /* training zeros in the TCF */ /* in tens of milliseconds */ } NFX_FAX_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 NFX_FAX_STATUS structure may contain any of the CTAERR or NFXERR values. Refer to Appendix B for a complete listing of error codes.

See Also

nfxReceiveFax, nfxSendFax



(Page 9 of 15 in this chapter) Version


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