GDK Version 5.0 Programming Reference Manual Table of Contents

• Operating System Support
• Preface
• Purpose
• Audience
• Using This Guide
• Conventions
• Reference Documentation
• 1. Introduction to Fax Technology
• Overview
• History
• Understanding Fax Technology
• Elements of a Fax Call
• Compression
• Resolution
• Routing
• Advantages of Computer-Based Faxing
• High-Quality Output
• Convenience
• Progress Monitoring
• Saves Time and Effort
• Standards
• Fax Applications
• 2. GDK System Architecture
• About GDK for Windows
• Minimum System Requirements
• About the Dialogic CP Fax Series Hardware
• Firmware Features
• GDK System Components
• Device Drivers for ISA and PCI
• Firmware Download Utility
• The GDK System Service (the Dispatcher)
• Network Drive Access
• About the Firmware
• About the Queue File
• GDK System Features
• TIFF Capability
• Binary File Transfer
• Routing
• Recording Line Noise
• Transparent PRI Support
• GDK System Configuration
• Control Panel Configuration Utility
• Setting the Country Code Properly
• 3. Configuration Commands
• Configuration Commands Summary
• Configuration Commands
• BUFFERS
• CHANNELID
• CHASSIS
• CONTROLT
• COUNTRY
• CSID
• DEBUG
• FIRMWARE
• GFCCONTROL 36
• GFCCONTROL 37
• GFXBOTTOMMARGIN
• GFXCARRYON
• GFXCHARSET
• GFXDID
• GFXDIGITS
• GFXDTMFTIMEOUT
• GFXDTMFTONE
• GFXECM
• GFXEXTEND
• GFXFAXCONTROL 29
• GFXFAXCONTROL 71
• GFXFAXCONTROL 72
• GFXFAXCONTROL 73
• GFXFAXCONTROL 74
• GFXFAXCONTROL 1020
• GFXFAXCONTROL 1021
• GFXFINE
• GFXFORM
• GFXHEADER
• GFXLEFTMARGIN
• GFXPAGELENGTH
• GFXRECM
• GFXRECVPATH
• GFXREJBURST
• GFXREJCOUNT
• GFXREJPERCENT
• GFXRIGHTMARGIN
• GFXRLENGTH
• GFXRTNRETRAIN
• GFXRTPRETRAIN
• GFXRT6
• GFXRTWOD
• GFXRWIDTH
• GFXSCANTIME
• GFXSEC
• GFXSHUTDOWN
• GFXSPEAKER
• GFXST6
• GFXSTWOD
• GFXTOPMARGIN
• GFXWAIT
• INIT
• LOADFONT
• MODEMCTRL 1024
• MODEMCTRL 2054
• MODEMCTRL 2066
• NUMCHAN
• QUEUET
• STATUST
• UPDATET
• New Parameter Summary
• Management Parameters
• AutoReceive
• PriLayerEnable
• NumberOfTrunks
• ChannelsPerTrunk
• FaxDistribution
• ISDNDistribution
• ISDN Parameter
• BC_xfer_cap
• Layer1_protocol
• BC_xfer_rate
• BC_xfer_mode
• originate_number_type
• originate_number_plan
• destination_number_type
• destination_number_plan
• destination_subnumber_type
• origination_subnumber_type
• origination_phone_number
• destination_sub_phone_number
• origination_subphone_number
• AcceptCallState
• PRI_Overlap_Digits
• PRI_Overlap_T1
• PRI_Overlap_T2
• CheckInBearer
• CheckInSetupFrame
• ErrorMapping Parameter
• ReservedByDialogic
• OfferedOnMakeCall
• MakeCallFail
• NoPhoneInQrec
• NoDialogicFree
• CallDisconnected
• ConnectAttemptFail
• WrongCRNAllocated
• NoFaxResource
• FaxNotReady
• NormalCause
• WrongBearer
• Debug Parameters
• UseSRAM
• SRAMMask
• LogFile
• LogFileMask
• DebugToSRAM
• UseGFAX$DL
• TraceTrunkNumber
• TraceFileName
• 4. Queue Record Programming
• Queue File Database Component
• About the Queue File
• Queue File Lists
• Queue File Pointers
• Using GFQRESET.EXE
• Pre-allocating Queue File Records
• Purging the Control List and Control Done List
• Checking and Repairing the Queue File
• Record Queuing and Processing
• Buffering Records
• Busy Records
• Fax Transaction Programming
• Queue Record Data Types
• Queue Record Fields
• Queue Record Field Descriptions
• Alphabetical Listing of Queue Record Fields
• 5. Programming Models
• GDK Subsystem
• Phases of a Fax Session
• Fax Programming Models
• Batch Programming Model
• GFQ APIs - Alphabetized List of the GFQ Functions
• gfqClearRec( )
• gfqFindFirst( )
• gfqFindNext( )
• gfqGetPath( )
• gfqInsertOne( )
• gfqInsertPlist( )
• gfqPurgeAll( )
• gfqPurgeOne( )
• gfqSearch( )
• gfqSubmit( )
• gfqSubmitPlist( )
• Interactive Programming Model
• Sample GRT Applications
• GRT API Data Structures
• GRT_EVENT( )
• GRT_INFO_DATA( )
• GRT_RESPONSE( )
• grtGetEvent( )
• grtInit( )
• grtProcessCallTermEvent( )
• grtProcessDialEvent( )
• grtProcessInfoEvent( )
• grtProcessRecvDCSEvent( )
• grtProcessRecvDISEvent( )
• grtRespond( )
• grtRespondContinue( )
• grtRespondEndCall( )
• grtRespondQueueRec( )
• grtStop( )
• grtSubmitFax( )
• GFD API Functions
• gfdClose( )
• gfdConnectNmPipe( )
• gfdDisConnectNmPipe( )
• gfdGetFileNumChannel( )
• gfdGetMemNumChannel( )
• gfdMakeNmPipe( )
• gfdOpenStatusFile( )
• gfdQueryStatus( )
• gfdRead( )
• gfdReadStatusFile( )
• gfdReadStatusFileHeader( )
• gfdReadStatusFileRecord( )
• gfdReadStatusMem( )
• gfdReclaimNmPipe( )
• gfdRemoteRequest( )
• Obsolete APIs
• 6. Developing with PEB
• PEB (Pulse Code Modulation [PCM] Expansion Bus)
• Basics of a PEB System
• PEB APIs
• gl_route( )
• gl_routerxtx( )
• gl_pebenter( )
• gl_pebexit( )
• 7. Developing with SCbus
• SCbus Connectivity Paradigm
• Basics of SCbus Compliancy
• SCbus APIs for the CP Fax SC Boards
• ScBus APIs With DM3 Boards
• Scbus API Descriptions
• gl_getctinfo( )
• gl_getxmitslot( )
• gl_listen( )
• gl_unlisten( )
• gl_scenter( )
• gl_scexit( )
• 8. Fax Status Files
• Overview
• Status Tables and Status Files
• Creating a Status File
• Refreshing the Status File
• Monitoring Status with gfxStatus
• Monitoring Status with cp_state
• GDK System Information API Function Calls
• gfdGetFileNumChannel( )
• gfdGetMemNumChannel( )
• gfdOpenStatusFile( )
• gfdQueryStatus( )
• gfdReadStatusFile( )
• gfdReadStatusFileHeader( )
• gfdReadStatusFileRecord( )
• gfdReadStatusMem( )
• glHWDetect( )
• Appendix A - Product Information
• Obtaining Additional Product Information
• Technical Support
• Appendix B - GFSH Commands
• GFSH Utility
• Appendix C - TIFF File Format
• Overview of TIFF File Format
• Appendix D - Information for International Users
• Full ASCII Character Set
• Country Codes
• Copyright notice