GDK Version 5.0 Programming Reference Manual for Windows Copyright © 2000 Dialogic Corporation 05-6025-002 COPYRIGHT NOTICE Copyright © 2000 Dialogic Corporation. All Rights Reserved. All contents of this document are subject to change without notice and do not represent a commitment on the part of Dialogic Corporation. Every effort is made to ensure the accuracy of this information. However, due to ongoing product improvements and revisions, Dialogic Corporation cannot guarantee the accuracy of this material, nor can it accept responsibility for errors or omissions. No warranties of any nature are extended by the information contained in these copyrighted materials. Use or implementation of any one of the concepts, applications, or ideas described in this document or on Web pages maintained by Dialogic-may infringe one or more patents or other intellectual property rights owned by third parties. Dialogic does not condone or encourage such infringement. Dialogic makes no warranty with respect to such infringement, nor does Dialogic waive any of its own intellectual property rights which may cover systems implementing one or more of the ideas contained herein. Procurement of appropriate intellectual property rights and licenses is solely the responsibility of the system implementer. The software referred to in this document is provided under a Software License Agreement. Refer to the Software License Agreement for complete details governing the use of the software. All names, products, and services mentioned herein are the trademarks or registered trademarks of their respective organizations and are the sole property of their respective owners. DIALOGIC (including the Dialogic logo), DTI/124, and SpringBoard are registered trademarks of Dialogic Corporation. A detailed trademark listing can be found at: http://www.dialogic.com/legal.htm. Publication Date: August, 2000 Part Number: 05-6025-002 Dialogic, an Intel Company 1515 Route 10 Parsippany NJ 07054 U.S.A. For Technical Support, visit the Dialogic support website at: http://support.dialogic.com For Sales Offices and other contact information, visit the main Dialogic website at: http://www.dialogic.com OPERATING SYSTEM SUPPORT The term Windows refers to both the Windows NT® and Windows® 2000 operating systems. For a complete list of supported Windows operating systems, refer to the Release Guide that came with your Dialogic System Release for Windows, or to the Dialogic support site at http://support.dialogic.com/releases. iii Table of Contents Preface................................................................................................................... 1 Purpose................................................................................................................... 1 Audience................................................................................................................. 1 Using This Guide.................................................................................................... 1 Conventions............................................................................................................ 1 Reference Documentation ...................................................................................... 2 1. Introduction to Fax Technology...................................................................... 3 Overview ................................................................................................................ 3 History.................................................................................................................... 3 Understanding Fax Technology.............................................................................. 4 Elements of a Fax Call...................................................................................... 4 Compression ..................................................................................................... 5 Resolution......................................................................................................... 5 Routing ............................................................................................................. 5 Advantages of Computer-Based Faxing................................................................. 6 High-Quality Output......................................................................................... 6 Convenience ..................................................................................................... 6 Progress Monitoring ......................................................................................... 7 Saves Time and Effort ...................................................................................... 7 Standards ................................................................................................................ 7 Fax Applications..................................................................................................... 8 2. GDK System Architecture ............................................................................... 9 About GDK for Windows....................................................................................... 9 Minimum System Requirements........................................................................... 10 About the Dialogic CP Fax Series Hardware ....................................................... 11 Firmware Features................................................................................................ 11 GDK System Components.................................................................................... 11 Device Drivers for ISA and PCI ..................................................................... 11 Firmware Download Utility............................................................................ 12 The GDK System Service (the Dispatcher) .................................................... 12 Network Drive Access.................................................................................... 14 About the Firmware........................................................................................ 15 About the Queue File...................................................................................... 15 GDK System Features .......................................................................................... 15 TIFF Capability .............................................................................................. 15 v GDK Version 5.0 Programming Reference Manual Binary File Transfer........................................................................................ 23 Routing ........................................................................................................... 24 Recording Line Noise ..................................................................................... 27 Transparent PRI Support ................................................................................ 27 GDK System Configuration.................................................................................. 28 Control Panel Configuration Utility................................................................ 28 Setting the Country Code Properly ................................................................. 28 3. Configuration Commands ............................................................................. 37 Configuration Commands Summary..................................................................... 37 Configuration Commands..................................................................................... 40 New Parameter Summary..................................................................................... 71 Management Parameters................................................................................. 72 ISDN Parameters ............................................................................................ 75 ErrorMapping Parameters............................................................................... 83 Debug Parameters........................................................................................... 89 4. Queue Record Programming......................................................................... 95 Queue File Database Component ......................................................................... 95 About the Queue File............................................................................................ 95 Queue File Lists.............................................................................................. 96 Queue File Pointers......................................................................................... 97 Using GFQRESET.EXE................................................................................. 97 Pre-allocating Queue File Records ................................................................. 98 Purging the Control List and Control Done List............................................. 99 Checking and Repairing the Queue File ......................................................... 99 Record Queuing and Processing........................................................................... 99 Buffering Records .............................................................................................. 100 Busy Records...................................................................................................... 100 Fax Transaction Programming ........................................................................... 101 Queue