(Page 1 of 1 in this chapter) Version

Chapter 5

Function Summary

5.1 Introduction
5.2 Working with Document Queues
5.3 Transmitting and Receiving Documents
5.4 Managing Image Format Conversion
5.5 Managing Pages and Document Contents
5.6 Monitoring Status

5.1 Introduction

This chapter summarizes the NaturalFax functions, organized by task. A NaturalFax fax application can accomplish the following tasks:

5.2 Working with Document Queues

The following functions control NaturalFax document queues:
Function

S / A1

 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.

1 Synchronous or Asynchronous

5.3 Transmitting and Receiving Documents

The following functions control fax operations:
Function

S / A1

 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.

1 Synchronous or Asynchronous

5.4 Managing Image Format Conversion

The following functions verify or convert the image formats of document files:
Function

S / A1

 Description

nfxCheckTIFF

 S

 Verifies that the specified file is in TIFF-F or TIFF-S format.

nfxConvertFileDirect

 S

 Performs file format conversion.

1 Synchronous or Asynchronous

5.5 Managing Pages and Document Contents

The following functions move pages of a document from one file to another:
Function

S / A1

 Description

nfxMergeFile

 S

 Combines multiple TIFF-F or TIFF-S files into a single TIFF-F or TIFF-S file.

nfxSplitFile

 S

 Splits a single TIFF-F or TIFF-S file into a specified number of TIFF-F or TIFF-S files.

1 Synchronous or Asynchronous

5.6 Monitoring Status

The following functions retrieve NaturalFax status information:
Function

S /A1

 Description

nfxGetSessionStatus

 S

 Returns status information during a fax send or receive operation.

nfxGetDocStatus

 S

 Returns status of a document in the specified queue.

1 Synchronous or Asynchronous


(Page 1 of 1 in this chapter) Version

tech_support@nmss.com
Copyright © 1999, Natural MicroSystems, Inc. All rights reserved.