(Page 3 of 5 in this chapter)

Alphabetical Error Summary

Error Name

Code

Description

CTAERR_BAD_ARGUMENT

0x7

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

CTAERR_FILE_EXISTS

0x24

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

CTAERR_FILE_NOT_FOUND

0x21

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

CTAERR_FILE_OPEN_FAILED

0x25

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

CTAERR_FILE_READ_FAILED

0x27

Problem: The file is not opened or is locked, or the expected amount of data could not be read.
Solution: 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

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

CTAERR_FUNCTION_ACTIVE

0xF

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

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

CTAERR_FUNCTION_NOT_AVAIL

0xD

A NaturalFax DSP overlay 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

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

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

CTAERR_OUT_OF_MEMORY

0x6

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

CTAERR_OUT_OF_RESOURCES

0x8

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

The specified file is not in TIFF-F format.

NFXERR_BAD_PAGE_SIZE

0x05020B

Unsupported page size.

NFXERR_BUFFER_UNDERRUN

0x050211

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_BUFFER_OVERRUN

0x050212

On fax receive, buffers to receive the incoming image data have not been provided in time.

NFXERR_CHECK_BAD_LINES

0x05020D

Returned by nfxCheckTIFF to indicate that there are bad lines in the TIFF-F file. The file can still be transmitted by NaturalFax, and status information returned by nfxCheckTIFF is valid.

NFXERR_CHECK_DIFF_ATTRIB

0x05020E

Returned by nfxCheckTIFF to indicate that all pages in the TIFF-F 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

The called fax machine was not detected. Check that the number you are dialing is a fax machine.

NFXERR_CONVERSION_REQUIRED

0x05020C

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_INTERNAL

0x58000-
0x5FFFF

An unexpected internal error has occurred.

NFXERR_LICENSE_ALREADY_ALLOC

0x050205

A fax license unit is already allocated to this CTA context

NFXERR_NEGOTIATION_FAILED

0x050202

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 the remote transmitter sent a DCN message or did not send a capabilities frame (DCS).

NFXERR_NO_LICENSE

0x050204

No fax license unit is allocated to this CTA context.

NFXERR_NO_MORE_LICENSES

0x050203

There are no available fax license units.

NFXERR_NO_MORE_DOCUMENTS

0x05020F

The fax session ended because there were no more receive files in the receive document queue.

NFXERR_OPEN_QUEUE_FAILED

0x05020A

Could not open the specified document queue. Check that you have a valid transmit queue.

NFXERR_QUEUE_EMPTY

0x050206

The specified document queue is empty.

NFXERR_QUEUE_TOO_LATE

0x050208

Attempted to enqueue a file in an active transmit or receive queue too late in the fax session.

NFXERR_RATE_TOO_LOW

0x050210

The receiving or transmitting fax terminal is attempting to receive or transmit at a rate lower than the minrate

NFXERR_SESSION_FAILED

0x050209

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.

Error Name	Code	Description
CTAERR_BAD_ARGUMENT	0x7	Problem: A function argument had an invalid value or a required pointer argument was NULL. Solution: Check all arguments for valid types and ranges.
CTAERR_FILE_EXISTS	0x24	Problem: You attempted to create a file that already exists. Solution: Remove or rename the existing file, or specify a different file name.
CTAERR_FILE_NOT_FOUND	0x21	Problem: The specified file does not exist. Solution: Create the file or specify a different file name.
CTAERR_FILE_OPEN_FAILED	0x25	Problem: File open failed due to a system error. Solution: Verify that the file exists.
CTAERR_FILE_READ_FAILED	0x27	Problem: The file is not opened or is locked, or the expected amount of data could not be read. Solution: 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	Problem: The file is not open or is locked, or the expected amount of data could not be written. Solution: Verify that an incorrect handle was not used to close another file.
CTAERR_FUNCTION_ACTIVE	0xF	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	An attempt was made to stop or modify a function that was not running.
CTAERR_FUNCTION_NOT_AVAIL	0xD	A NaturalFax DSP overlay 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	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	An invalid handle was passed as an argument to this function.
CTAERR_OUT_OF_MEMORY	0x6	Problem: Unable to allocate memory for queue, driver or CTA context, for play or record buffers, or for temporary storage. Solution: When this error occurs on a DONE event, it may mean that there was insufficient memory on the board.
CTAERR_OUT_OF_RESOURCES	0x8	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	The specified file is not in TIFF-F format.
NFXERR_BAD_PAGE_SIZE	0x05020B	Unsupported page size.
NFXERR_BUFFER_UNDERRUN	0x050211	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_BUFFER_OVERRUN	0x050212	On fax receive, buffers to receive the incoming image data have not been provided in time.
NFXERR_CHECK_BAD_LINES	0x05020D	Returned by `nfxCheckTIFF` to indicate that there are bad lines in the TIFF-F file. The file can still be transmitted by NaturalFax, and status information returned by `nfxCheckTIFF` is valid.
NFXERR_CHECK_DIFF_ATTRIB	0x05020E	Returned by `nfxCheckTIFF` to indicate that all pages in the TIFF-F 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	The called fax machine was not detected. Check that the number you are dialing is a fax machine.
NFXERR_CONVERSION_REQUIRED	0x05020C	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_INTERNAL	0x58000- 0x5FFFF	An unexpected internal error has occurred.
NFXERR_LICENSE_ALREADY_ALLOC	0x050205	A fax license unit is already allocated to this CTA context
NFXERR_NEGOTIATION_FAILED	0x050202	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 the remote transmitter sent a DCN message or did not send a capabilities frame (DCS).
NFXERR_NO_LICENSE	0x050204	No fax license unit is allocated to this CTA context.
NFXERR_NO_MORE_LICENSES	0x050203	There are no available fax license units.
NFXERR_NO_MORE_DOCUMENTS	0x05020F	The fax session ended because there were no more receive files in the receive document queue.
NFXERR_OPEN_QUEUE_FAILED	0x05020A	Could not open the specified document queue. Check that you have a valid transmit queue.
NFXERR_QUEUE_EMPTY	0x050206	The specified document queue is empty.
NFXERR_QUEUE_TOO_LATE	0x050208	Attempted to enqueue a file in an active transmit or receive queue too late in the fax session.
NFXERR_RATE_TOO_LOW	0x050210	The receiving or transmitting fax terminal is attempting to receive or transmit at a rate lower than the `minrate`
NFXERR_SESSION_FAILED	0x050209	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.

(Page 3 of 5 in this chapter)

tech_support@nmss.com