# nfxGetSessionStatus

Returns status information during a fax send or receive operation.

#### Prototype

DWORD nfxGetSessionStatus ( CTAHD ctahd, NFX_FAX_STATUS *ptr_fax_status)

Argument | Description
ctahd | 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 */ char remoteSUB[NFX_MAX_SUB]; /* Received Sub-Address string from */ /* remote station */ DWORD sub_sent; /* Set if Sub-Address frame is sent to */ /* remote station */ DWORD modemtype; /* Modem used to transfer document */ } NFX_FAX_STATUS;

#### Return values

Return value | Description
SUCCESS |
CTAERR_BAD_ARGUMENT | A function argument is invalid.
CTAERR_INVALID_CTAHD | The specified context handle is invalid.

#### Events

None.

#### Details

Use nfxGetSessionStatus to return additional information about the state of the fax session when the most recent event occurred.

The error field in the NFX_FAX_STATUS structure may contain any of the CTAERR or NFXERR values. For more information, refer to the Alphabetical error summary.

Note: Modem metrics are currently supported on the AG and CG boards.

For more information, refer to Monitoring fax session status.

#### See also

nfxReceiveFax, nfxSendFax