(Page 1 of 1 in this chapter) Version

Appendix B

Error Summary

Introduction

Alphabetical Error Summary

Numerical Error Summary

Introduction

This appendix provides a summary of NaturalFax error codes. 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 CT Access and CT 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.
Additional information about an error condition may be available 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. See the CT Access Developer's Reference Manual for CT Access error codes.

Alphabetical Error Summary

Error Name

Hex

Decimal

Description

CTAERR_BAD_ARGUMENT

0x7

7

A function argument had an invalid value or a required pointer argument was NULL. Check all arguments for valid types and ranges.

CTAERR_FILE_EXISTS

0x24

36

You attempted to create a file that already exists. Remove or rename the existing file, or specify a different file name.

CTAERR_FILE_NOT_FOUND

0x21

33

The specified file does not exist. Create the file or specify a different file name.

CTAERR_FILE_OPEN_FAILED

0x25

37

File open failed due to a system error. Verify that the file exists.

CTAERR_FILE_READ_FAILED

0x27

39

The file is not opened or is locked, or the expected amount of data could not be read. Make sure that the file is of the expected type. Verify that an incorrect handle was not used to close another file.

CTAERR_FILE_WRITE_FAILED

0x28

40

The file is not open or is locked, or the expected amount of data could not be written. Verify that an incorrect handle was not used to close another file.

CTAERR_FUNCTION_ACTIVE

0xF

15

A function is already running on the CTA context. Be sure your application waits for a DONE event from other fax or voice operations before initiating a new fax operation.

CTAERR_FUNCTION_NOT_ACTIVE

0xE

14

An attempt was made to stop or modify a function that was not running.

CTAERR_FUNCTION_NOT_AVAIL

0xD

13

A NaturalFax DSP file has not been downloaded to the board. Check your AG configuration file and review agerror.log and ag.rpt for start-up problems.

CTAERR_INVALID_CTAHD

0x5

5

An invalid CTA context handle was passed as an argument to a function or the context was destroyed by another thread.

CTAERR_INVALID_HANDLE

0x20

32

An invalid handle was passed as an argument to this function.

CTAERR_OUT_OF_MEMORY

0x6

6

Unable to allocate memory for queue, driver or CTA context, for play or record buffers, or for temporary storage. When this error occurs on a DONE event, it may mean that there was insufficient memory on the board.

CTAERR_OUT_OF_RESOURCES

0x8

8

A NaturalFax DSP function could not be started. Check to see that you are using the proper AG configuration for your application. Check to see that you have not exceeded the maximum number of fax operations for your hardware configuration.

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 in time. 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 been 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 can not 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 AG 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.

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. May indicate a T.30 timeout or failure to receive a post page message. Check your host processor CPU and I/O loading.

The following table is an alphabetical listing of errors. All errors are 32 bits.

Error Name	Hex	Decimal	Description
`CTAERR_BAD_ARGUMENT`	`0x7`	`7`	A function argument had an invalid value or a required pointer argument was `NULL`. Check all arguments for valid types and ranges.
`CTAERR_FILE_EXISTS`	`0x24`	`36`	You attempted to create a file that already exists. Remove or rename the existing file, or specify a different file name.
`CTAERR_FILE_NOT_FOUND`	`0x21`	`33`	The specified file does not exist. Create the file or specify a different file name.
`CTAERR_FILE_OPEN_FAILED`	`0x25`	`37`	File open failed due to a system error. Verify that the file exists.
`CTAERR_FILE_READ_FAILED`	`0x27`	`39`	The file is not opened or is locked, or the expected amount of data could not be read. Make sure that the file is of the expected type. Verify that an incorrect handle was not used to close another file.
`CTAERR_FILE_WRITE_FAILED`	`0x28`	`40`	The file is not open or is locked, or the expected amount of data could not be written. Verify that an incorrect handle was not used to close another file.
`CTAERR_FUNCTION_ACTIVE`	`0xF`	`15`	A function is already running on the CTA context. Be sure your application waits for a `DONE` event from other fax or voice operations before initiating a new fax operation.
`CTAERR_FUNCTION_NOT_ACTIVE`	`0xE`	`14`	An attempt was made to stop or modify a function that was not running.
`CTAERR_FUNCTION_NOT_AVAIL`	`0xD`	`13`	A NaturalFax DSP file has not been downloaded to the board. Check your AG configuration file and review `agerror.log` and `ag.rpt` for start-up problems.
`CTAERR_INVALID_CTAHD`	`0x5`	`5`	An invalid CTA context handle was passed as an argument to a function or the context was destroyed by another thread.
`CTAERR_INVALID_HANDLE`	`0x20`	`32`	An invalid handle was passed as an argument to this function.
`CTAERR_OUT_OF_MEMORY`	`0x6`	`6`	Unable to allocate memory for queue, driver or CTA context, for play or record buffers, or for temporary storage. When this error occurs on a `DONE` event, it may mean that there was insufficient memory on the board.
`CTAERR_OUT_OF_RESOURCES`	`0x8`	`8`	A NaturalFax DSP function could not be started. Check to see that you are using the proper AG configuration for your application. Check to see that you have not exceeded the maximum number of fax operations for your hardware configuration.
`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 in time. 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 been 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 can not 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 AG 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`.
`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. May indicate a T.30 timeout or failure to receive a post page message. Check your host processor CPU and I/O loading.

Numerical Error Summary

The following table lists NaturalFax and CT Access errors in numerical order: Hex Decimal Error Name 0x5 5 CTAERR_INVALID_CTAHD 0x6 6 CTAERR_OUT_OF_MEMORY 0x7 7 CTAERR_BAD_ARGUMENT 0x8 8 CTAERR_OUT_OF_RESOURCES 0xD 13 CTAERR_FUNCTION_NOT_AVAIL 0xE 14 CTAERR_FUNCTION_NOT_ACTIVE 0xF 15 CTAERR_FUNCTION_ACTIVE 0x20 32 CTAERR_INVALID_HANDLE 0x21 33 CTAERR_FILE_NOT_FOUND 0x24 36 CTAERR_FILE_EXISTS 0x25 37 CTAERR_FILE_OPEN_FAILED 0x27 39 CTAERR_FILE_READ_FAILED 0x28 40 CTAERR_FILE_WRITE_FAILED 0x050201 328193 NFXERR_CONNECT_FAILED 0x050202 328194 NFXERR_NEGOTIATION_FAILED 0x050206 328198 NFXERR_QUEUE_EMPTY 0x050207 328199 NFXERR_BAD_FILE_FORMAT 0x050208 328200 NFXERR_QUEUE_TOO_LATE 0x050209 328201 NFXERR_SESSION_FAILED 0x05020A 328202 NFXERR_OPEN_QUEUE_FAILED 0x05020B 328203 NFXERR_BAD_PAGE_SIZE 0x05020C 328204 NFXERR_CONVERSION_REQUIRED 0x05020D 328205 NFXERR_CHECK_BAD_LINES 0x05020E 328206 NFXERR_CHECK_DIFF_ATTRIB 0x050210 328208 NFXERR_RATE_TOO_LOW 0x050211 328209 NFXERR_BUFFER_UNDERRUN 0x050212 328210 NFXERR_BUFFER_OVERRUN 0x050213 328211 NFXERR_NO_MODEMS 0x050214 328212 NFXERR_NO_PPM 0x050215 328213 NFXERR_NO_PPM_RESPONSE 0x050217 328215 NFXERR_PROTOCOL_ERROR 0x050219 328217 NFXERR_FAX_SERVICE 0x05021A 328218 NFXERR_FXM_SERVICE 0x05021B 328219 NFXERR_REMOTE_DCN 0x05021C 328220 NFXERR_NO_REMOTE 0x05021D 328221 NFXERR_CARRIER_LOST 0x05021E 328222 NFXERR_RETRAIN_NEGATIVE 0x058000-0x05FFFF 360448 - 393215 NFX_INTERNAL_ERROR

Hex	Decimal	Error Name
`0x5`	`5`	`CTAERR_INVALID_CTAHD`
`0x6`	`6`	`CTAERR_OUT_OF_MEMORY`
`0x7`	`7`	`CTAERR_BAD_ARGUMENT`
`0x8`	`8`	`CTAERR_OUT_OF_RESOURCES`
`0xD`	`13`	`CTAERR_FUNCTION_NOT_AVAIL`
`0xE`	`14`	`CTAERR_FUNCTION_NOT_ACTIVE`
`0xF`	`15`	`CTAERR_FUNCTION_ACTIVE`
`0x20`	`32`	`CTAERR_INVALID_HANDLE`
`0x21`	`33`	`CTAERR_FILE_NOT_FOUND`
`0x24`	`36`	`CTAERR_FILE_EXISTS`
`0x25`	`37`	`CTAERR_FILE_OPEN_FAILED`
`0x27`	`39`	`CTAERR_FILE_READ_FAILED`
`0x28`	`40`	`CTAERR_FILE_WRITE_FAILED`
`0x050201`	`328193`	`NFXERR_CONNECT_FAILED`
`0x050202`	`328194`	`NFXERR_NEGOTIATION_FAILED`
`0x050206`	`328198`	`NFXERR_QUEUE_EMPTY`
`0x050207`	`328199`	`NFXERR_BAD_FILE_FORMAT`
`0x050208`	`328200`	`NFXERR_QUEUE_TOO_LATE`
`0x050209`	`328201`	`NFXERR_SESSION_FAILED`
`0x05020A`	`328202`	`NFXERR_OPEN_QUEUE_FAILED`
`0x05020B`	`328203`	`NFXERR_BAD_PAGE_SIZE`
`0x05020C`	`328204`	`NFXERR_CONVERSION_REQUIRED`
`0x05020D`	`328205`	`NFXERR_CHECK_BAD_LINES`
`0x05020E`	`328206`	`NFXERR_CHECK_DIFF_ATTRIB`
`0x050210`	`328208`	`NFXERR_RATE_TOO_LOW`
`0x050211`	`328209`	`NFXERR_BUFFER_UNDERRUN`
`0x050212`	`328210`	`NFXERR_BUFFER_OVERRUN`
`0x050213`	`328211`	`NFXERR_NO_MODEMS`
`0x050214`	`328212`	`NFXERR_NO_PPM`
`0x050215`	`328213`	`NFXERR_NO_PPM_RESPONSE`
`0x050217`	`328215`	`NFXERR_PROTOCOL_ERROR`
`0x050219`	`328217`	`NFXERR_FAX_SERVICE`
`0x05021A`	`328218`	`NFXERR_FXM_SERVICE`
`0x05021B`	`328219`	`NFXERR_REMOTE_DCN`
`0x05021C`	`328220`	`NFXERR_NO_REMOTE`
`0x05021D`	`328221`	`NFXERR_CARRIER_LOST`
`0x05021E`	`328222`	`NFXERR_RETRAIN_NEGATIVE`
`0x058000-0x05FFFF`	`360448 -` `393215`	`NFX_INTERNAL_ERROR`

(Page 1 of 1 in this chapter) Version

tech_support@nmss.com