nfxCreateQueue

Description

This function creates a queue for either sending or receiving fax documents.

Prototype

ctahd Handle returned by ctaCreateContext; queue_type Type of document queue (either NFX_DOC_RECEIVE or NFX_DOC_TRANSMIT); ptr_queue_handle Pointer to a location to receive a valid queue handle on a successful return

Return Values

SUCCESS The function completed successfully.
CTAERR_BAD_ARGUMENT Invalid function argument passed.
CTAERR_INVALID_CTAHD The specified CTA context handle is invalid.
CTAERR_INVALID_HANDLE The specified document queue handle is invalid.
CTAERR_OUT_OF_MEMORY Memory allocation failed.
NFXERR_OPEN_QUEUE_FAILED An error occurred while accessing a document queue.

Events

None.

Details

The document queue data structure is maintained internally by NaturalFax and a handle is returned for use with all other NaturalFax functions. Each document queue is associated with a specified CTA context. Subsequent calls to nfxEnqueueDoc, nfxDestroyQueue, nfxSendFax, nfxReceiveFax, or nfxAnswerPoll will verify that the document queue is associated with the same CTA context as the current operation. It is possible to have many document queues associated with a given CTA context, but only one send queue and one receive queue can be associated with an active fax session. For example, to send multiple queues, you must call nfxSendFax for each queue.

Converting TIFF-F Files: nfxcnvrt

Name

nfxcnvrt

Purpose

A utility that converts a TIFF-F file to an output TIFF-F file with the specified attributes for encoding, resolution, page width, and bad line management.

Usage

nfxcnvrt input_file output_file [convert_encoding [convert_resolution [convert_page_width [convert_bad_line]]]]

Description

The default attributes constitute capabilities that are found in every fax terminal. Therefore, any file processed by nfxcnvrt using the default attribute values will be sendable to any fax terminal, regardless of its capabilities.
Unless you specify different attributes in the command line arguments, nfxcnvrt uses the following default values: convert_encoding     NFX_ENCODE_1D convert_resolution    NFX_RESOLUTION_LOW convert_page_width   NFX_PAGE_WIDTH_A4 convert_bad_line     NFX_BAD_LINE_ACTION_REPT

A screen message displays the number of pages processed.

You can set convert_resolution to: NFX_RESOLUTION_HIGH NFX_RESOLUTION_LOW NFX_RESOLUTION_SUPER_HIGH

You can set convert_encoding to:

NFX_ENCODE_1D
NFX_ENCODE_2D

You can set convert_page_width to:

You can set convert_bad_line to:

NFX_BAD_LINE_ACTION_DROP

NFX_BAD_LINE_ACTION_PREV

NFX_BAD_LINE_ACTION_TICK

Top