# Alphabetical error summary

Error codes with their corresponding descriptions are presented in two tables for quick reference:

- Alphabetically ordered by error code name including a description of the problem

- Numerically ordered in hexadecimal with the decimal equivalent and error name

All Natural Access and Natural Access service functions return a status code. If the return code is not SUCCESS (0), it is an error code indicating that the function has failed and a reason for the failure.

An application can retrieve additional information about an error condition by calling nfxGetSessionStatus or nfxGetDocStatus and examining the error field in the NFX_FAX_STATUS structure or the lasterror field in NFX_DOC_STATUS. A table with these error codes is also provided.

NaturalFax error codes are prefixed with NFXERR, and are defined in nfxdef.h. For information about Natural Access error codes (prefixed with CTAERR), refer to the Natural Access Developer's Reference Manual.

The following table lists NaturalFax errors in alphabetical order. All errors are 32 bit.

Error name | Hex | Decimal | Description
--- | --- | --- | ---
NFXERR_BAD_FILE_FORMAT | 0x050207 | 328199 | The specified file is not in TIFF-F or TIFF-S format.
NFXERR_BAD_PAGE_SIZE | 0x05020B | 328203 | Unsupported page size.
NFXERR_BUFFER_UNDERRUN | 0x050211 | 328209 | On fax transmit, buffers of image data have not been provided. Check your host computer loading to be sure events and disk I/O are being processed in a timely fashion.
NFXERR_CARRIER_LOST | 0x05021D | 328221 | The received signal has fallen below the level specified by NFX_RECEIVE_PARMS.threshold, and the fax session has terminated.
NFXERR_CHECK_BAD_LINES | 0x05020D | 328205 | Returned by nfxCheckTIFF to indicate that there are bad lines in the TIFF-F or TIFF-S file. The file can still be transmitted by NaturalFax, and status information returned by nfxCheckTIFF is valid.
NFXERR_CHECK_DIFF_ATTRIB | 0x05020E | 328206 | Returned by nfxCheckTIFF to indicate that all pages in the TIFF-F or TIFF-S file do not have the same attributes (for encoding, page width, and resolution). The file may not be transmitted by NaturalFax, but the status information returned by nfxCheckTIFF is valid.
NFXERR_CONNECT_FAILED | 0x050201 | 328193 | The called fax machine was not detected. Check that the number you are dialing is a fax machine.
NFXERR_CONVERSION_REQUIRED | 0x05020C | 328204 | Cannot transmit file because there is a mismatch between the stored file format and the receiving fax terminal's capabilities and on-the-fly conversion has been disabled (otfmode in the receive or transmit parameters is set to NFX_OTF_NEVER).
NFXERR_FAX_SERVICE | 0x050219 | 328217 | A fatal error occurred in the FAX service.
NFXERR_FXM_SERVICE | 0x05021A | 328218 | A fatal error occurred in the FXM service.
NFXERR_INCOMPATIBLE_RECEIVER | 0x050216 | 328214 | The application has disabled on-the-fly conversion and the receiver cannot handle the specified image format.
NFXERR_INTERNAL_ERROR | 0x58000 - 0x5FFFF | 360448 - 393215 | An unexpected internal error has occurred.
NFXERR_NEGOTIATION_FAILED | 0x050202 | 328194 | Failed T.30 fax negotiation at the beginning of a session or between documents. When transmitting, this error indicates that training failed (usually due to bad phone line quality) or that the transmitter and receiver capabilities do not match. When receiving, this error indicates that training failed.
NFXERR_NO_MODEMS | 0x050213 | 328211 | The required DSP files are not configured or loaded to the board. The FXM service failed to start.
NFXERR_NO_PPM | 0x050214 | 328212 | The receiver has not received a correct post-page message.
NFXERR_NO_PPM_RESPONSE | 0x050215 | 328213 | The receiver has not returned a correct response to the post-page message.
NFXERR_NO_REMOTE | 0x05021C | 328220 | The called fax terminal did not send a DIS signal.
NFXERR_OPEN_QUEUE_FAILED | 0x05020A | 328202 | Could not open the specified document queue. Check that you have a valid transmit queue.
NFXERR_PROTOCOL_ERROR | 0x050217 | 328215 | A T.30 protocol error occurred.
NFXERR_QUEUE_EMPTY | 0x050206 | 328198 | The specified document queue is empty.
NFXERR_QUEUE_TOO_LATE | 0x050208 | 328200 | Attempted to enqueue a file in an active transmit queue too late in the fax session.
NFXERR_RATE_TOO_LOW | 0x050210 | 328208 | The receiving or transmitting fax terminal is attempting to receive or transmit at a rate lower than the minrate parameter.
NFXERR_REMOTE_DCN | 0x05021B | 328219 | The remote terminal has sent an unexpected disconnect (DCN) command frame.
NFXERR_RETRAIN_NEGATIVE | 0x05021E | 328222 | The page was received with errors, and NaturalFax has requested that the remote transmitter retransmit the last page.
NFXERR_SESSION_FAILED | 0x050209 | 328201 | The fax session failed due to an unexpected event. This error can indicate a T.30 timeout or failure to receive a post page message. Check your host processor CPU and I/O loading.
NFXERR_T5_TIMEOUT | 0x05021F | 328223 | The receiver is not ready to receive after T5 (60 +/- 5 seconds).