(Page 1 of 1 in this chapter)

Chapter 5

Function Summary

This chapter summarizes the NaturalFax functions, organized by task. A NaturalFax fax application can accomplish the following tasks: Work with document queues Transmit or receive fax documents Manage image format conversion Manipulate pages and document contents Monitor status Terminate the fax session Manage fax licenses

The following functions control NaturalFax document queues: Function S / A* Description nfxCreateQueue S Creates a queue for either sending or receiving documents. nfxEnqueueDoc S Adds a document to a document queue. nfxDestroyQueue S Deletes the specified document queue. nfxResetQueue S Resets all documents in a queue to unsent. *Synchronous or Asynchronous

Function	S / A*	Description
`nfxCreateQueue`	S	Creates a queue for either sending or receiving documents.
`nfxEnqueueDoc`	S	Adds a document to a document queue.
`nfxDestroyQueue`	S	Deletes the specified document queue.
`nfxResetQueue`	S	Resets all documents in a queue to unsent.

The following functions control fax operations: Function S / A* Description nfxSendFax A Starts negotiating with the remote fax receiver and subsequently sends all the documents in the send queue. nfxReceiveFax A Starts negotiating as the called fax terminal and then places all received documents into the receive queue. nfxAnswerFaxPoll A Provides a queue of documents to send in response to a poll request from the remote sending fax terminal. nfxStopSession A Stops a fax send or receive operation in progress. *Synchronous or Asynchronous

Function	S / A*	Description
`nfxSendFax`	A	Starts negotiating with the remote fax receiver and subsequently sends all the documents in the send queue.
`nfxReceiveFax`	A	Starts negotiating as the called fax terminal and then places all received documents into the receive queue.
`nfxAnswerFaxPoll`	A	Provides a queue of documents to send in response to a poll request from the remote sending fax terminal.
`nfxStopSession`	A	Stops a fax send or receive operation in progress.

The following functions verify or convert the image formats of document files: Function S / A* Description nfxCheckTIFF S Verifies that the specified file is in TIFF-F format. nfxConvertFileDirect S Performs file format conversion. *Synchronous or Asynchronous

Function	S / A*	Description
`nfxCheckTIFF`	S	Verifies that the specified file is in TIFF-F format.
`nfxConvertFileDirect`	S	Performs file format conversion.

The following functions move pages of a document from one file to another: Function S / A* Description nfxMergeFile S Combines multiple TIFF-F files into a single TIFF-F file. nfxSplitFile S Splits a single TIFF-F file into a specified number of TIFF-F files. *Synchronous or Asynchronous

Function	S / A*	Description
`nfxMergeFile`	S	Combines multiple TIFF-F files into a single TIFF-F file.
`nfxSplitFile`	S	Splits a single TIFF-F file into a specified number of TIFF-F files.

The following functions retrieve NaturalFax status information: Function S /A* Description nfxGetSessionStatus S Returns status information during a fax send or receive operation. nfxGetDocStatus S Returns status of a document in the specified queue. *Synchronous or Asynchronous

Function	S /A*	Description
`nfxGetSessionStatus`	S	Returns status information during a fax send or receive operation.
`nfxGetDocStatus`	S	Returns status of a document in the specified queue.

Function	S / A*	Description
`nfxGetLicense`	S	Reserves a fax license unit for a fax session.
`nfxReleaseLicense`	S	Releases a fax license unit explicitly reserved for a fax session.
`nfxGetLicenseStatus`	S	Gets the total and active authorized fax license units.

(Page 1 of 1 in this chapter)