NaturalFax Developer's Reference Manual

P/N 6350-21

About This Manual v

Developer Support vii

1 Introduction

1.1 About NaturalFax

1.2 NaturalFax Performance on AG Boards

1.2.1 Maximizing the Ports Running Fax Transmit 4

1.2.2 Maximizing Universal Ports 5

1.2.3 Supporting all Ports on a Board 6

1.3 About the CT Access Environment

1.3.1 Programming Model 7

1.3.2 CT Access Components 8

1.3.3 Managing NaturalFax Parameters in CT Access 9

2.1 Introduction

2.2 Services Required for NaturalFax

2.3 Setting Up the CT Access Environment

2.3.1 Creating Event Queues and CTA Contexts 15

2.3.2 Opening Services 15

2.4 Establishing a Call

2.4.1 Placing a Call 18

2.4.2 Receiving a Call 18

2.5 Working with Document Queues

2.5.1 Building a Document Queue 19

2.5.2 Tearing Down or Resetting a Document Queue 20

2.6 Transmitting and Receiving Faxes

2.6.1 Transmitting Faxes 21

2.6.2 Receiving Faxes 21

2.6.3 Polling the Called Fax Terminal 24

2.6.4 Answering a Poll Request 25

2.7 Performing Image Format Conversions

2.7.1 Image Characteristics 27

2.7.2 Image Conversions 29

2.8 Offline File Conversion

2.9 Online Image Conversion

2.9.1 Conversions When Transmitting Faxes 32

2.9.2 Conversions When Receiving Faxes 34

2.10 Monitoring Fax Session Status

2.10.1 Tracing NaturalFax Applications 36

2.10.2 Error Handling During a Fax Session 37

2.11 Terminating and Shutting Down

2.12 Managing Fax Licenses

3.1 Introduction

3.2 Working with Document Queues

3.3 Managing Document Conversion

3.4 Transmitting and Receiving Documents

3.5 Monitoring Status

3.6 Managing Fax License Management

3.7 Managing Pages and Document Contents

4.1 Introduction

nfxAllocLicense 49

nfxAnswerFaxPoll 50

nfxCheckTIFF 55

nfxConvertFileDirect 58

nfxCreateQueue 61

nfxDestroyQueue 63

nfxEnqueueDoc 64

nfxGetDocStatus 67

nfxGetLicenseStatus 71

nfxGetSessionStatus 72

nfxMergeFile 75

nfxReceiveFax 77

nfxReleaseLicense 82

nfxResetQueue 83

nfxSendFax 84

nfxSplitFile 91

nfxStopSession 93

5.1 Introduction

Sending a Fax: nfxsend 97

Receiving a Fax: nfxrecv 98

Verifying TIFF-F Format: nfxcheck 99

Splitting TIFF-F Files: nfxsplit 100

Merging TIFF-F Files: nfxmerge 101

Converting TIFF-F Files: nfxcnvrt 102

Converting ASCII Files: nfxtxttf 104

Printing Number of Licenses: nfxports 105