home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / SDKs / FaxSTF™ Developers Kit 3.2 / C Libraries / FaxSTFLib.h < prev    next >
Encoding:
Text File  |  1996-06-25  |  7.2 KB  |  177 lines  |  [TEXT/CWIE]
  1. //***************************************************************
  2. //    File :        FaxSTFLib.h
  3. //    Authors :    Steve Kirk &Scott Hemme
  4. //    Created :    Thur, Feb 1, 1996
  5. //    CopyRight:    ©1987 - 1996 STF Technologies, Inc.
  6. //                All Rights Reserved
  7. //      Notes:     The libraries were compiled as follows.
  8. //            4 byte int's -- OFF
  9. //            8 byte doubles -- OFF
  10. //***************************************************************
  11.  
  12. #ifndef __FAXSTFLIB_32__
  13. #define __FAXSTFLIB_32__
  14.  
  15.  
  16. //****************************************************************
  17. //  Definitions
  18. //****************************************************************
  19.  
  20. #define saveHeader         saveCoverPage
  21. #define setHeader         setCoverPage
  22. #define restoreHeader     restoreCoverPage
  23.  
  24. enum {
  25.     kIdle = 0,
  26.     kSending,
  27.     kReceiving
  28. };
  29.  
  30. //****************************************************************
  31. //  Errors
  32. //****************************************************************
  33.  
  34. #define kSTFToolBoxNotFound        -9000            // STF Toolbox not found
  35. #define kSTFToolBoxBusy            -9001            // STF Toolbox could not be opened read/write
  36. #define kSTFSettingsNotFound    -9002            // STF Settings file not found
  37. #define kSTFSettingsFileBusy    -9003            // STF Settings file could not be opened read/write
  38. #define kSTFNoGXSupport            -9004            // FaxPrint GX 3.3 or greater not installed***
  39. #define kSTFBadIndex            -9005            // Index out of range
  40. #define kSTFBrdDrvrFail            -9006            //  Call to the STF Board Driver failed
  41. #define kSTFMonitorNotFound     -9007            // STF FaxMonitor not found
  42. #define kGetPrinterFail            -9008            // Failed to get the printer name
  43. #define KFaxPrintGXNotFound        -9009            // FaxPrint GX not found
  44. #define kFailtoSwitchDTP        -9010            // Failed to switch the desktop printer (GX only)
  45.  
  46. //****************************************************************
  47. //  Prototypes
  48. //****************************************************************
  49.  
  50. // addressing calls
  51. //==========================================
  52. pascal OSErr startup(Str255 note, long sendTime, Boolean autoDeleteFax, Boolean callGroupFax, short cvPgId, Str63 archiveFolder);
  53. pascal OSErr addDestinations (Str31 sendToFaxPhone, Str31 sendToVoicePhone, Str31 sendToCoName, Str31 sendToFirstName,
  54.                                                              Str31 sendToLastName, Str15 sendToSalutation);
  55. pascal OSErr shutDown(void);
  56.  
  57. // Manual send/receive
  58. //==========================================
  59. pascal OSErr ManualSend (FSSpecPtr theFile);
  60. pascal OSErr ManualReceive (void);
  61.  
  62. // switch printer calls
  63. //==========================================
  64. pascal OSErr doSwitchPrinter (Str31 NewPrinter, Str31 OldPrinter);
  65. pascal OSErr doSwitchToFaxPrint (Str31 oldPrinter);
  66. pascal OSErr doRestorePrinter(void);
  67.  
  68. // other stuff
  69. //==========================================
  70. pascal OSErr doGetSoftwareState(Boolean *flag);
  71. pascal OSErr doScanSpoolFolder(void);
  72. pascal OSErr isFaxSTFInstalled(short *stfInstalled);
  73. pascal OSErr getSTFDriverStatus (short *status);            // -- status = idle(0), sending(1), receiving(2)
  74.  
  75. // switch settings files calls
  76. //==========================================
  77. pascal OSErr saveCurSettingsFile(void);
  78. pascal OSErr switchSettingsFiles(Str255 newSettingsFileName);
  79. pascal OSErr restoreSettingsFile(void);
  80.  
  81. // settings calls
  82. //==========================================
  83. // -- CallBlocking settings panel routines
  84. pascal OSErr saveCallBlockingState(void);
  85. pascal OSErr setCallBlockingState(Boolean state, Str63 number);        // if (number == "\p") then this routine only sets the state
  86. pascal OSErr restoreCallBlockingState(void);
  87.  
  88. // -- Connection settings panel routines
  89. pascal OSErr saveConnectionSettings(void);
  90. pascal OSErr setConnectionSettings(Str63 portName);
  91. pascal OSErr restoreConnectionSettings(void);
  92.  
  93. // -- CoverPage settings panel routines
  94. pascal OSErr saveCoverPage(void);                                                    // same as saveHeader
  95. pascal OSErr setCoverPage(Str63 name,Str63 company,Str63 faxPhone,Str63 voicePhone);        // same as setHeader
  96. pascal OSErr restoreCoverPage(void);                                                // same as restoreHeader
  97.  
  98. // -- Dialing settings panel routines
  99. pascal OSErr saveDialingSettings(void);
  100. pascal OSErr setDialingSettings(short phone,short detect,short carrier,short commaPause,Str63 prefix,Str63 suffix,Str63 macro);
  101. pascal OSErr restoreDialingSettings(void);
  102.  
  103. // -- FaxForward settings panel routines
  104. pascal OSErr saveFaxForwardState(void);
  105. pascal OSErr setFaxForwardState(Boolean state, Str63 number);    // pass "\p" for number to only toggle the state
  106. pascal OSErr restoreFaxForwardState(void);
  107.  
  108. // -- FaxIn settings panel routines
  109. pascal OSErr saveFaxInState(void);
  110. pascal OSErr setFaxInState(short processType, short day, short hour, short minute);
  111. pascal OSErr restoreFaxInState(void);
  112.  
  113. // -- FaxMenu settings panel routines
  114. pascal OSErr saveFaxMenuSettings(void);
  115. pascal OSErr setFaxMenu(Boolean shiftKey, Boolean commandKey, Boolean optionKey);
  116. pascal OSErr restoreFaxMenuSettings(void);
  117.  
  118. // -- FaxModem settings panel routines
  119. // -- Never(1),Connect(2),Handshake(3),Always(4)
  120. // -- volume         Low(1),Medium(2),High(3)
  121. // -- answerOn    Number of rings to answer on plus one.
  122. // -- sendSpeed    2400(1),4800(2),7200(3),9600(4),12000(5),14400(6)
  123. // -- recvSpeed    2400(1),4800(2),7200(3),9600(4),12000(5),14400(6)
  124. pascal OSErr saveFaxModemSettings(void);
  125. pascal OSErr setFaxModemSettings(short speakerOn, short volume, short answerOn, short sendSpeed, short recvSpeed);
  126. pascal OSErr restoreFaxModemSettings(void);
  127.  
  128. // -- FaxQueue settings panel routines
  129. pascal OSErr saveFaxQueueSettings(void);
  130. pascal OSErr setFaxQueueSettings(short sampleRate, short sampleSize, short callGrouping);
  131. pascal OSErr restoreFaxQueueSettings(void);
  132.  
  133. // -- FaxSoftware settings panel routines
  134. pascal OSErr saveFaxSoftwareSettings(void);
  135. pascal OSErr setFaxSoftwareSettings(short callRetries, short retryInterval, Boolean PageHeader, Boolean confirmTrans,
  136.                                                 Boolean notifyRecept, Boolean faxStatus, Str27 stationMessage);
  137. pascal OSErr pageHeaderOn(void);
  138. pascal OSErr pageHeaderOff(void);
  139. pascal OSErr faxOn(void);
  140. pascal OSErr faxOff(void);
  141. pascal OSErr restoreFaxSoftwareSettings(void);
  142.  
  143. // -- ModemInit settings panel routines
  144. pascal OSErr saveModemInitSettings(void);
  145. pascal OSErr setModemInitSettings(Str255 initString);
  146. pascal OSErr restoreModemInitSettings(void);
  147.  
  148. // -- PageHeader settings panel routines
  149. pascal OSErr savePageHeader(void);
  150. pascal OSErr setPageHeaderOpts(Boolean icons,Boolean date,Boolean pages,Boolean time);
  151. pascal OSErr setPageHeaderStandard(Boolean voice, Boolean orginization);
  152. pascal OSErr setPageHeaderCustom(Str63  custHeader);
  153. pascal OSErr restorePageHeader(void);
  154.  
  155. // -- Places settings panel routines
  156. pascal OSErr savePlacesState(void);
  157. pascal OSErr setPlacesState(short index);                        // -- pass -1 in index to turn off, 0 - 29 to select an entry in the location list (1 - 30)
  158. pascal OSErr restorePlacesState(void);
  159.  
  160. // -- Network settings panel routines
  161. pascal OSErr saveNetworkState(void);
  162. pascal OSErr setNetworkState(Boolean state);
  163. pascal OSErr restoreNetworkState(void);
  164.  
  165. // -- Security settings panel routines
  166. pascal OSErr saveSecurityState(void);
  167. pascal OSErr setSecurityState(Boolean state, Str63 password);
  168. pascal OSErr restoreSecurityState(void);
  169.  
  170. // -- TollSaver settings panel routines
  171. pascal OSErr saveTollSaver(void);
  172. pascal OSErr setTollSaverState(Boolean state);
  173. pascal OSErr setTollSaverTimes(short beginHour, short beginMinute, short endHour, short endMinute);
  174. pascal OSErr restoreTollSaver(void);
  175.  
  176. #endif
  177.