home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / SDKs / FaxSTF™ Developers Kit 3.2 / C Libraries / FaxSTFIntf.p next >
Encoding:
Text File  |  1996-06-25  |  11.4 KB  |  299 lines  |  [TEXT/CWIE]
  1. {    File :        FaxSTFIntf.p                                }
  2. {    Authors :    Steve Kirk                                     }
  3. {    Created :    Thursday, April 18, 1996                    }
  4. {    CopyRight:    ©1987 - 1996 STF Technologies, Inc.            }
  5. {                All Rights Reserved                            }
  6.  
  7. unit FaxDevIntf;
  8.  
  9. interface
  10.  
  11. uses
  12.     MemTypes, OSIntf, ToolIntf, Folders, gestaltequ, Aliases, SysEqu, PackIntf;
  13.  
  14.  
  15. const
  16. { ---Error Codes --- }
  17.     kSTFToolBoxNotFound        =    -9000            { -- STF Toolbox not found -- }
  18.     kSTFToolBoxBusy            =    -9001            { -- STF Toolbox could not be opened read/write -- }
  19.     kSTFSettingsNotFound    =    -9002            { -- STF Settings file not found -- }
  20.     kSTFSettingsFileBusy    =    -9003            { -- STF Settings file could not be opened read/write -- }
  21.     kSTFNoGXSupport            =    -9004            { -- FaxPrint GX 3.3 or greater not installed -- }
  22.     kSTFBadIndex            =    -9005            { -- Index out of range -- }
  23.     kSTFBrdDrvrFail            =    -9006            { -- Call to the STF Board Driver failed -- }
  24.     kSTFMonitorNotFound     =    -9007            { -- STF FaxMonitor not found -- }
  25.     kGetPrinterFail            =    -9008            { -- Failed to get the printer name -- }
  26.     KFaxPrintGXNotFound        =    -9009            { -- FaxPrint GX not found -- }
  27.     kFailtoSwitchDTP        =    -9010            { -- Failed to switch the desktop printer (GX only) -- }
  28.     
  29. { ---Misc Const---}
  30.     kIdle                     = 0
  31.     kSending                = 1
  32.     kReceiving                = 2
  33.  
  34. {--------------------------------------------------------}
  35. { -- The following library calls will allow you to create faxes from the printing loop of your app        -- }
  36. { -- refer to the documentation sent with this Developer kit for further details on all of these calls.    -- }
  37.  
  38. { -- addressing calls -- }
  39.  
  40. function Startup (Note: str255; SendTime: longint; AutoDeleteFax: Boolean; CallGroupFax: Boolean; CvPgId: integer; ArchiveFolderName: Str63): OSErr;
  41. function AddDestinations (SendToFaxPhone: Str31; SendToVoicePhone: Str31; SendToCoName: Str31; SendToFirstName: Str31; SendToLastName: Str31; SendToSalutation: Str15): OSErr;
  42. function ShutDown: OSErr;
  43.  
  44. { -- switch printer calls -- }
  45.  
  46. function DoSwitchPrinter (NewPrinter: Str31; var OldPrinter: Str31): OSErr;
  47. function doSwitchToFaxPrint (var oldPrinter: Str31 ): OSErr;
  48. function doRestorePrinter: OSErr;
  49.  
  50. { -- other stuff -- }
  51. function doGetSoftwareState(var flag: Boolean): OSErr;
  52. function doScanSpoolFolder: OSErr;
  53. function isFaxSTFInstalled(var stfInstalled: integer): OSErr;
  54. function getSTFDriverStatus (var status: integer): OSErr;        { -- status = idle(0), sending(1), receiving(2) -- }
  55.  
  56. { -- switch settings files calls -- }
  57.  
  58. function saveCurSettingsFile: OSErr;
  59. function switchSettingsFiles(newSettingsFileName: Str255): OSErr
  60. function restoreSettingsFile: OSErr;
  61.  
  62. { -- settings calls -- }
  63. {--------------------------------------------------------}
  64.  
  65. { -- CallBlocking settings panel routines -- }
  66. function saveCallBlockingState: OSErr;
  67. function setCallBlockingState(state: Boolean, number: Str63): OSErr;        { -- if (number == "\p") then this routine only sets the state -- }
  68. function restoreCallBlockingState: OSErr;
  69.  
  70. { -- Connection settings panel routines -- }
  71. function saveConnectionSettings: OSErr;
  72. function setConnectionSettings(portName: Str63): OSErr;
  73. function restoreConnectionSettings: OSErr;
  74.  
  75. { -- CoverPage settings panel routines -- }
  76. function saveCoverPage: OSErr;                        { -- same as saveHeader -- }
  77. function setCoverPage(name: Str63; company: Str63; faxPhone: Str63; voicePhone:Str63): OSErr;        { -- same as setHeader -- }
  78. function restoreCoverPage: OSErr;                    { -- same as restoreHeader -- }
  79.  
  80. { -- Dialing settings panel routines -- }
  81. function saveDialingSettings: OSErr;
  82. function setDialingSettings(phone: integer; detect: integer; carrier: integer; commaPause: integer; prefix: Str63; suffix: Str63; macro: Str63);
  83. function restoreDialingSettings: OSErr;
  84.  
  85. { -- FaxForward settings panel routines -- }
  86. function saveFaxForwardState: OSErr;
  87. function setFaxForwardState(state: Boolean; number: Str63): OSErr;    { -- pass empty string for number to only toggle the state -- }
  88. function restoreFaxForwardState: OSErr;
  89.  
  90. { -- FaxIn settings panel routines -- }
  91. function saveFaxInState: OSErr;
  92. function setFaxInState(processType: integer; day: integer; hour: integer, minute: integer): OSErr;
  93. function restoreFaxInState: OSErr;
  94.  
  95. { -- FaxMenu settings panel routines -- }
  96. function saveFaxMenuSettings: OSErr;
  97. function setFaxMenu(shiftKey: Boolean; commandKey: Boolean; optionKey: Boolean): OSErr;
  98. function restoreFaxMenuSettings: OSErr;
  99.  
  100. { -- FaxModem settings panel routines -- }
  101. { -- Never(1),Connect(2),Handshake(3),Always(4)                        -- }
  102. { -- volume         Low(1),Medium(2),High(3)                            -- }
  103. { -- answerOn    Number of rings to answer on plus one.                -- }
  104. { -- sendSpeed    2400(1),4800(2),7200(3),9600(4),12000(5),14400(6)    -- }
  105. { -- recvSpeed    2400(1),4800(2),7200(3),9600(4),12000(5),14400(6)    -- }
  106. function saveFaxModemSettings: OSErr;
  107. function setFaxModemSettings(speakerOn: integer; volume: integer; answerOn: integer; sendSpeed: integer; recvSpeed: integer);
  108. function restoreFaxModemSettings: OSErr;
  109.  
  110. { -- FaxQueue settings panel routines -- }
  111. function saveFaxQueueSettings: OSErr;
  112. function setFaxQueueSettings(sampleRate: integer; sampleSize: integer; callGrouping: integer): OSErr;
  113. function restoreFaxQueueSettings: OSErr;
  114.  
  115. { -- FaxSoftware settings panel routines -- }
  116. function saveFaxSoftwareSettings: OSErr;
  117. function setFaxSoftwareSettings(callRetries: integer; retryInterval: integer; PageHeader: Boolean; confirmTrans: Boolean; notifyRecept: Boolean; faxStatus: Boolean; stationMessage: Str27);
  118. function pageHeaderOn: OSErr;
  119. function pageHeaderOff: OSErr;
  120. function faxOn: OSErr;
  121. function faxOff: OSErr;
  122. function restoreFaxSoftwareSettings: OSErr;
  123.  
  124. { -- ModemInit settings panel routines -- }
  125. function saveModemInitSettings: OSErr;
  126. function setModemInitSettings(initString: Str255): OSErr;
  127. function restoreModemInitSettings: OSErr;
  128.  
  129. { -- PageHeader settings panel routines -- }
  130. function savePageHeader: OSErr;
  131. function setPageHeaderOpts(icons: Boolean; date: Boolean; pages: Boolean; time: Boolean): OSErr;
  132. function setPageHeaderStandard(voice: Boolean; orginization: Boolean): OSErr;
  133. function setPageHeaderCustom(custHeader: Str63): OSErr;
  134. function restorePageHeader: OSErr;
  135.  
  136. { -- Places settings panel routines -- }
  137.  
  138. function savePlacesState: OSErr;
  139. function setPlacesState(index: integer): OSErr;        { -- pass -1 in index to turn off, 0 - 29 to select an entry in the location list (1 - 30) -- }
  140. function restorePlacesState: OSErr;
  141.  
  142. { -- Network settings panel routines -- }
  143. function saveNetworkState: OSErr;
  144. function setNetworkState(state: Boolean): OSErr;
  145. function restoreNetworkState: OSErr;
  146.  
  147. { -- Security settings panel routines -- }
  148. function saveSecurityState: OSErr;
  149. function setSecurityState(state: Boolean; password: Str63): OSErr;
  150. function restoreSecurityState: OSErr;
  151.  
  152. { -- TollSaver settings panel routines -- }
  153. function saveTollSaver: OSErr;
  154. function setTollSaverState(state: Boolean): OSErr;
  155. function setTollSaverTimes(beginHour: integer; beginMinute: integer; endHour: integer; endMinute: integer): OSErr;
  156. function restoreTollSaver: OSErr;
  157.  
  158. {--------------------------------------------------------}
  159. implementation
  160.  
  161. function Startup (Note: str255; SendTime: longint; AutoDeleteFax: Boolean; CallGroupFax: Boolean; CvPgId: integer; ArchiveFolderName: Str63): OSErr;
  162. external;
  163. function AddDestinations (SendToFaxPhone: Str31; SendToVoicePhone: Str31; SendToCoName: Str31; SendToFirstName: Str31; SendToLastName: Str31; SendToSalutation: Str15): OSErr;
  164. external;
  165. function ShutDown: OSErr;
  166. external;
  167. function DoSwitchPrinter (NewPrinter: Str31; var OldPrinter: Str31): OSErr;
  168. external;
  169. function doSwitchToFaxPrint (var oldPrinter: Str31 ): OSErr;
  170. external;
  171. function doRestorePrinter: OSErr;
  172. external;
  173. function doGetSoftwareState(var flag: Boolean): OSErr;
  174. external;
  175. function doScanSpoolFolder: OSErr;
  176. external;
  177. function isFaxSTFInstalled(var stfInstalled: integer): OSErr;
  178. external;
  179. function getSTFDriverStatus (var status: integer): OSErr;    
  180. external;
  181. function saveCurSettingsFile: OSErr;
  182. external;
  183. function switchSettingsFiles(newSettingsFileName: Str255): OSErr
  184. external;
  185. function restoreSettingsFile: OSErr;
  186. external;
  187. function saveCallBlockingState: OSErr;
  188. external;
  189. function setCallBlockingState(state: Boolean, number: Str63): OSErr;    
  190. external;
  191. function restoreCallBlockingState: OSErr;
  192. external;
  193. function saveConnectionSettings: OSErr;
  194. external;
  195. function setConnectionSettings(portName: Str63): OSErr;
  196. external;
  197. function restoreConnectionSettings: OSErr;
  198. external;
  199. function saveCoverPage: OSErr;                        
  200. external;
  201. function setCoverPage(name: Str63; company: Str63; faxPhone: Str63; voicePhone:Str63): OSErr;
  202. external;
  203. function restoreCoverPage: OSErr;                    
  204. external;
  205. function saveDialingSettings: OSErr;
  206. external;
  207. function setDialingSettings(phone: integer; detect: integer; carrier: integer; commaPause: integer; prefix: Str63; suffix: Str63; macro: Str63);
  208. external;
  209. function restoreDialingSettings: OSErr;
  210. external;
  211. function saveFaxForwardState: OSErr;
  212. external;
  213. function setFaxForwardState(state: Boolean; number: Str63): OSErr;    { -- pass empty string for number to only toggle the state -- }
  214. external;
  215. function restoreFaxForwardState: OSErr;
  216. external;
  217. function saveFaxInState: OSErr;
  218. external;
  219. function setFaxInState(processType: integer; day: integer; hour: integer, minute: integer): OSErr;
  220. external;
  221. function restoreFaxInState: OSErr;
  222. external;
  223. function saveFaxMenuSettings: OSErr;
  224. external;
  225. function setFaxMenu(shiftKey: Boolean; commandKey: Boolean; optionKey: Boolean): OSErr;
  226. external;
  227. function restoreFaxMenuSettings: OSErr;
  228. external;
  229. function saveFaxModemSettings: OSErr;
  230. external;
  231. function setFaxModemSettings(speakerOn: integer; volume: integer; answerOn: integer; sendSpeed: integer; recvSpeed: integer);
  232. external;
  233. function restoreFaxModemSettings: OSErr;
  234. external;
  235. function saveFaxQueueSettings: OSErr;
  236. external;
  237. function setFaxQueueSettings(sampleRate: integer; sampleSize: integer; callGrouping: integer): OSErr;
  238. external;
  239. function restoreFaxQueueSettings: OSErr;
  240. external;
  241. function saveFaxSoftwareSettings: OSErr;
  242. external;
  243. function setFaxSoftwareSettings(callRetries: integer; retryInterval: integer; PageHeader: Boolean; confirmTrans: Boolean; notifyRecept: Boolean; faxStatus: Boolean; stationMessage: Str27);
  244. external;
  245. function pageHeaderOn: OSErr;
  246. external;
  247. function pageHeaderOff: OSErr;
  248. external;
  249. function faxOn: OSErr;
  250. external;
  251. function faxOff: OSErr;
  252. external;
  253. function restoreFaxSoftwareSettings: OSErr;
  254. external;
  255. function saveModemInitSettings: OSErr;
  256. external;
  257. function setModemInitSettings(initString: Str255): OSErr;
  258. external;
  259. function restoreModemInitSettings: OSErr;
  260. external;
  261. function savePageHeader: OSErr;
  262. external;
  263. function setPageHeaderOpts(icons: Boolean; date: Boolean; pages: Boolean; time: Boolean): OSErr;
  264. external;
  265. function setPageHeaderStandard(voice: Boolean; orginization: Boolean): OSErr;
  266. external;
  267. function setPageHeaderCustom(custHeader: Str63): OSErr;
  268. external;
  269. function restorePageHeader: OSErr;
  270. external;
  271. function savePlacesState: OSErr;
  272. external;
  273. function setPlacesState(index: integer): OSErr;        
  274. external;
  275. function restorePlacesState: OSErr;
  276. external;
  277. function saveNetworkState: OSErr;
  278. external;
  279. function setNetworkState(state: Boolean): OSErr;
  280. external;
  281. function restoreNetworkState: OSErr;
  282. external;
  283. function saveSecurityState: OSErr;
  284. external;
  285. function setSecurityState(state: Boolean; password: Str63): OSErr;
  286. external;
  287. function restoreSecurityState: OSErr;
  288. external;
  289. function saveTollSaver: OSErr;
  290. external;
  291. function setTollSaverState(state: Boolean): OSErr;
  292. external;
  293. function setTollSaverTimes(beginHour: integer; beginMinute: integer; endHour: integer; endMinute: integer): OSErr;
  294. external;
  295. function restoreTollSaver: OSErr;
  296. external;
  297.  
  298. {--------------------------------------------------------}
  299. end.