source: trunk/Packages/synapse/docs/help/synaser.html

Last change on this file was 2, checked in by chronos, 13 years ago
  • Přidáno: Základní kostra projektu.
  • Přidáno: Knihovna synapse.
File size: 17.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
2<html>
3<head>
4<meta name="GENERATOR" content="PasDoc 0.9.0">
5<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
6<title>synaser</title>
7<link rel="StyleSheet" type="text/css" href="pasdoc.css">
8</head>
9<body bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#800080" alink="#FF0000">
10<h1 class="unit">Unit synaser</h1>
11<table class="sections">
12<tr>
13<td><a class="section" href="#@Description">Description</a></td><td><a class="section" href="#@Uses">uses</a></td><td><a class="section" href="#@Classes">Classes, Interfaces, Objects and Records</a></td><td><a class="section" href="#@FuncsProcs">Functions and Procedures</a></td><td><a class="section" href="#@Types">Types</a></td><td><a class="section" href="#@Constants">Constants</a></td><td>Variables</td></tr></table>
14<a name="@Description"></a><h2 class="description">Description</h2>
15&nbsp;<a name="@Uses"></a><h2 class="uses">uses</h2>
16<ul class="useslist"><li>Windows</li><li>registry</li><li><a href="synafpc.html">synafpc</a></li><li>Classes</li><li>SysUtils</li><li><a href="synautil.html">synautil</a></li></ul><h2 class="overview">Overview</h2>
17<a name="@Classes"></a><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
18<table class="classestable">
19<tr class="listheader">
20<th class="itemname">Name</th>
21<th class="itemdesc">Description</th>
22</tr>
23<tr class="list">
24<td class="itemname">Class&nbsp;<a class="bold" href="synaser.ESynaSerError.html"><code>ESynaSerError</code></a></td>
25<td class="itemdesc">Exception type for SynaSer errors</td>
26</tr>
27<tr class="list2">
28<td class="itemname">Class&nbsp;<a class="bold" href="synaser.TBlockSerial.html"><code>TBlockSerial</code></a></td>
29<td class="itemdesc">Main class implementing all communication routines</td>
30</tr>
31</table>
32<a name="@FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
33<table class="summary">
34<tr class="list">
35<td class="itemcode"><code>function <b><a href="synaser.html#GetSerialPortNames">GetSerialPortNames</a></b>: string;</code></td>
36</tr>
37</table>
38<a name="@Types"></a><h3 class="summary">Types</h3>
39<table class="summary">
40<tr class="list">
41<td class="itemcode"><code><b><a href="synaser.html#THookSerialReason">THookSerialReason</a></b> = (...);</code></td>
42</tr>
43<tr class="list2">
44<td class="itemcode"><code><b><a href="synaser.html#THookSerialStatus">THookSerialStatus</a></b> = procedure(Sender: TObject; Reason: <a href="synaser.html#THookSerialReason">THookSerialReason</a>; const Value: string) of object;</code></td>
45</tr>
46</table>
47<a name="@Constants"></a><h3 class="summary">Constants</h3>
48<table class="summary">
49<tr class="list">
50<td class="itemcode"><code><b><a href="synaser.html#CR">CR</a></b> = #$0d;</code></td>
51</tr>
52<tr class="list2">
53<td class="itemcode"><code><b><a href="synaser.html#LF">LF</a></b> = #$0a;</code></td>
54</tr>
55<tr class="list">
56<td class="itemcode"><code><b><a href="synaser.html#CRLF">CRLF</a></b> = <a href="synaser.html#CR">CR</a> + <a href="synaser.html#LF">LF</a>;</code></td>
57</tr>
58<tr class="list2">
59<td class="itemcode"><code><b><a href="synaser.html#cSerialChunk">cSerialChunk</a></b> = 8192;</code></td>
60</tr>
61<tr class="list">
62<td class="itemcode"><code><b><a href="synaser.html#LockfileDirectory">LockfileDirectory</a></b> = '/var/lock';</code></td>
63</tr>
64<tr class="list2">
65<td class="itemcode"><code><b><a href="synaser.html#PortIsClosed">PortIsClosed</a></b> = -1;</code></td>
66</tr>
67<tr class="list">
68<td class="itemcode"><code><b><a href="synaser.html#ErrAlreadyOwned">ErrAlreadyOwned</a></b> = 9991;</code></td>
69</tr>
70<tr class="list2">
71<td class="itemcode"><code><b><a href="synaser.html#ErrAlreadyInUse">ErrAlreadyInUse</a></b> = 9992;</code></td>
72</tr>
73<tr class="list">
74<td class="itemcode"><code><b><a href="synaser.html#ErrWrongParameter">ErrWrongParameter</a></b> = 9993;</code></td>
75</tr>
76<tr class="list2">
77<td class="itemcode"><code><b><a href="synaser.html#ErrPortNotOpen">ErrPortNotOpen</a></b> = 9994;</code></td>
78</tr>
79<tr class="list">
80<td class="itemcode"><code><b><a href="synaser.html#ErrNoDeviceAnswer">ErrNoDeviceAnswer</a></b> = 9995;</code></td>
81</tr>
82<tr class="list2">
83<td class="itemcode"><code><b><a href="synaser.html#ErrMaxBuffer">ErrMaxBuffer</a></b> = 9996;</code></td>
84</tr>
85<tr class="list">
86<td class="itemcode"><code><b><a href="synaser.html#ErrTimeout">ErrTimeout</a></b> = 9997;</code></td>
87</tr>
88<tr class="list2">
89<td class="itemcode"><code><b><a href="synaser.html#ErrNotRead">ErrNotRead</a></b> = 9998;</code></td>
90</tr>
91<tr class="list">
92<td class="itemcode"><code><b><a href="synaser.html#ErrFrame">ErrFrame</a></b> = 9999;</code></td>
93</tr>
94<tr class="list2">
95<td class="itemcode"><code><b><a href="synaser.html#ErrOverrun">ErrOverrun</a></b> = 10000;</code></td>
96</tr>
97<tr class="list">
98<td class="itemcode"><code><b><a href="synaser.html#ErrRxOver">ErrRxOver</a></b> = 10001;</code></td>
99</tr>
100<tr class="list2">
101<td class="itemcode"><code><b><a href="synaser.html#ErrRxParity">ErrRxParity</a></b> = 10002;</code></td>
102</tr>
103<tr class="list">
104<td class="itemcode"><code><b><a href="synaser.html#ErrTxFull">ErrTxFull</a></b> = 10003;</code></td>
105</tr>
106<tr class="list2">
107<td class="itemcode"><code><b><a href="synaser.html#dcb_Binary">dcb_Binary</a></b> = $00000001;</code></td>
108</tr>
109<tr class="list">
110<td class="itemcode"><code><b><a href="synaser.html#dcb_ParityCheck">dcb_ParityCheck</a></b> = $00000002;</code></td>
111</tr>
112<tr class="list2">
113<td class="itemcode"><code><b><a href="synaser.html#dcb_OutxCtsFlow">dcb_OutxCtsFlow</a></b> = $00000004;</code></td>
114</tr>
115<tr class="list">
116<td class="itemcode"><code><b><a href="synaser.html#dcb_OutxDsrFlow">dcb_OutxDsrFlow</a></b> = $00000008;</code></td>
117</tr>
118<tr class="list2">
119<td class="itemcode"><code><b><a href="synaser.html#dcb_DtrControlMask">dcb_DtrControlMask</a></b> = $00000030;</code></td>
120</tr>
121<tr class="list">
122<td class="itemcode"><code><b><a href="synaser.html#dcb_DtrControlDisable">dcb_DtrControlDisable</a></b> = $00000000;</code></td>
123</tr>
124<tr class="list2">
125<td class="itemcode"><code><b><a href="synaser.html#dcb_DtrControlEnable">dcb_DtrControlEnable</a></b> = $00000010;</code></td>
126</tr>
127<tr class="list">
128<td class="itemcode"><code><b><a href="synaser.html#dcb_DtrControlHandshake">dcb_DtrControlHandshake</a></b> = $00000020;</code></td>
129</tr>
130<tr class="list2">
131<td class="itemcode"><code><b><a href="synaser.html#dcb_DsrSensivity">dcb_DsrSensivity</a></b> = $00000040;</code></td>
132</tr>
133<tr class="list">
134<td class="itemcode"><code><b><a href="synaser.html#dcb_TXContinueOnXoff">dcb_TXContinueOnXoff</a></b> = $00000080;</code></td>
135</tr>
136<tr class="list2">
137<td class="itemcode"><code><b><a href="synaser.html#dcb_OutX">dcb_OutX</a></b> = $00000100;</code></td>
138</tr>
139<tr class="list">
140<td class="itemcode"><code><b><a href="synaser.html#dcb_InX">dcb_InX</a></b> = $00000200;</code></td>
141</tr>
142<tr class="list2">
143<td class="itemcode"><code><b><a href="synaser.html#dcb_ErrorChar">dcb_ErrorChar</a></b> = $00000400;</code></td>
144</tr>
145<tr class="list">
146<td class="itemcode"><code><b><a href="synaser.html#dcb_NullStrip">dcb_NullStrip</a></b> = $00000800;</code></td>
147</tr>
148<tr class="list2">
149<td class="itemcode"><code><b><a href="synaser.html#dcb_RtsControlMask">dcb_RtsControlMask</a></b> = $00003000;</code></td>
150</tr>
151<tr class="list">
152<td class="itemcode"><code><b><a href="synaser.html#dcb_RtsControlDisable">dcb_RtsControlDisable</a></b> = $00000000;</code></td>
153</tr>
154<tr class="list2">
155<td class="itemcode"><code><b><a href="synaser.html#dcb_RtsControlEnable">dcb_RtsControlEnable</a></b> = $00001000;</code></td>
156</tr>
157<tr class="list">
158<td class="itemcode"><code><b><a href="synaser.html#dcb_RtsControlHandshake">dcb_RtsControlHandshake</a></b> = $00002000;</code></td>
159</tr>
160<tr class="list2">
161<td class="itemcode"><code><b><a href="synaser.html#dcb_RtsControlToggle">dcb_RtsControlToggle</a></b> = $00003000;</code></td>
162</tr>
163<tr class="list">
164<td class="itemcode"><code><b><a href="synaser.html#dcb_AbortOnError">dcb_AbortOnError</a></b> = $00004000;</code></td>
165</tr>
166<tr class="list2">
167<td class="itemcode"><code><b><a href="synaser.html#dcb_Reserveds">dcb_Reserveds</a></b> = $FFFF8000;</code></td>
168</tr>
169<tr class="list">
170<td class="itemcode"><code><b><a href="synaser.html#SB1">SB1</a></b> = 0;</code></td>
171</tr>
172<tr class="list2">
173<td class="itemcode"><code><b><a href="synaser.html#SB1andHalf">SB1andHalf</a></b> = 1;</code></td>
174</tr>
175<tr class="list">
176<td class="itemcode"><code><b><a href="synaser.html#SB2">SB2</a></b> = 2;</code></td>
177</tr>
178<tr class="list2">
179<td class="itemcode"><code><b><a href="synaser.html#sOK">sOK</a></b> = 0;</code></td>
180</tr>
181<tr class="list">
182<td class="itemcode"><code><b><a href="synaser.html#sErr">sErr</a></b> = integer(-1);</code></td>
183</tr>
184</table>
185<h2 class="description">Description</h2>
186<h3 class="detail">Functions and Procedures</h3>
187<table class="detail">
188<tr class="list">
189<td class="itemcode"><a name="GetSerialPortNames"></a><code>function <b>GetSerialPortNames</b>: string;</code></td>
190</tr>
191</table>
192<p>
193Returns list of existing computer serial ports. Working properly only in Windows!</p>
194<h3 class="detail">Types</h3>
195<table class="detail">
196<tr class="list">
197<td class="itemcode"><a name="THookSerialReason"></a><code><b>THookSerialReason</b> = (...);</code></td>
198</tr>
199</table>
200<p>
201Possible status event types for <a class="normal" href="synaser.html#THookSerialStatus">THookSerialStatus</a></p>
202<ul>
203<li>
204HR_SerialClose: </li>
205<li>
206HR_Connect: </li>
207<li>
208HR_CanRead: </li>
209<li>
210HR_CanWrite: </li>
211<li>
212HR_ReadCount: </li>
213<li>
214HR_WriteCount: </li>
215<li>
216HR_Wait: </li>
217</ul>
218<table class="detail">
219<tr class="list">
220<td class="itemcode"><a name="THookSerialStatus"></a><code><b>THookSerialStatus</b> = procedure(Sender: TObject; Reason: <a href="synaser.html#THookSerialReason">THookSerialReason</a>; const Value: string) of object;</code></td>
221</tr>
222</table>
223<p>
224procedural prototype for status event hooking</p>
225<h3 class="detail">Constants</h3>
226<table class="detail">
227<tr class="list">
228<td class="itemcode"><a name="CR"></a><code><b>CR</b> = #$0d;</code></td>
229</tr>
230</table>
231&nbsp;<table class="detail">
232<tr class="list">
233<td class="itemcode"><a name="LF"></a><code><b>LF</b> = #$0a;</code></td>
234</tr>
235</table>
236&nbsp;<table class="detail">
237<tr class="list">
238<td class="itemcode"><a name="CRLF"></a><code><b>CRLF</b> = <a href="synaser.html#CR">CR</a> + <a href="synaser.html#LF">LF</a>;</code></td>
239</tr>
240</table>
241&nbsp;<table class="detail">
242<tr class="list">
243<td class="itemcode"><a name="cSerialChunk"></a><code><b>cSerialChunk</b> = 8192;</code></td>
244</tr>
245</table>
246&nbsp;<table class="detail">
247<tr class="list">
248<td class="itemcode"><a name="LockfileDirectory"></a><code><b>LockfileDirectory</b> = '/var/lock';</code></td>
249</tr>
250</table>
251&nbsp;<table class="detail">
252<tr class="list">
253<td class="itemcode"><a name="PortIsClosed"></a><code><b>PortIsClosed</b> = -1;</code></td>
254</tr>
255</table>
256&nbsp;<table class="detail">
257<tr class="list">
258<td class="itemcode"><a name="ErrAlreadyOwned"></a><code><b>ErrAlreadyOwned</b> = 9991;</code></td>
259</tr>
260</table>
261&nbsp;<table class="detail">
262<tr class="list">
263<td class="itemcode"><a name="ErrAlreadyInUse"></a><code><b>ErrAlreadyInUse</b> = 9992;</code></td>
264</tr>
265</table>
266&nbsp;<table class="detail">
267<tr class="list">
268<td class="itemcode"><a name="ErrWrongParameter"></a><code><b>ErrWrongParameter</b> = 9993;</code></td>
269</tr>
270</table>
271&nbsp;<table class="detail">
272<tr class="list">
273<td class="itemcode"><a name="ErrPortNotOpen"></a><code><b>ErrPortNotOpen</b> = 9994;</code></td>
274</tr>
275</table>
276&nbsp;<table class="detail">
277<tr class="list">
278<td class="itemcode"><a name="ErrNoDeviceAnswer"></a><code><b>ErrNoDeviceAnswer</b> = 9995;</code></td>
279</tr>
280</table>
281&nbsp;<table class="detail">
282<tr class="list">
283<td class="itemcode"><a name="ErrMaxBuffer"></a><code><b>ErrMaxBuffer</b> = 9996;</code></td>
284</tr>
285</table>
286&nbsp;<table class="detail">
287<tr class="list">
288<td class="itemcode"><a name="ErrTimeout"></a><code><b>ErrTimeout</b> = 9997;</code></td>
289</tr>
290</table>
291&nbsp;<table class="detail">
292<tr class="list">
293<td class="itemcode"><a name="ErrNotRead"></a><code><b>ErrNotRead</b> = 9998;</code></td>
294</tr>
295</table>
296&nbsp;<table class="detail">
297<tr class="list">
298<td class="itemcode"><a name="ErrFrame"></a><code><b>ErrFrame</b> = 9999;</code></td>
299</tr>
300</table>
301&nbsp;<table class="detail">
302<tr class="list">
303<td class="itemcode"><a name="ErrOverrun"></a><code><b>ErrOverrun</b> = 10000;</code></td>
304</tr>
305</table>
306&nbsp;<table class="detail">
307<tr class="list">
308<td class="itemcode"><a name="ErrRxOver"></a><code><b>ErrRxOver</b> = 10001;</code></td>
309</tr>
310</table>
311&nbsp;<table class="detail">
312<tr class="list">
313<td class="itemcode"><a name="ErrRxParity"></a><code><b>ErrRxParity</b> = 10002;</code></td>
314</tr>
315</table>
316&nbsp;<table class="detail">
317<tr class="list">
318<td class="itemcode"><a name="ErrTxFull"></a><code><b>ErrTxFull</b> = 10003;</code></td>
319</tr>
320</table>
321&nbsp;<table class="detail">
322<tr class="list">
323<td class="itemcode"><a name="dcb_Binary"></a><code><b>dcb_Binary</b> = $00000001;</code></td>
324</tr>
325</table>
326&nbsp;<table class="detail">
327<tr class="list">
328<td class="itemcode"><a name="dcb_ParityCheck"></a><code><b>dcb_ParityCheck</b> = $00000002;</code></td>
329</tr>
330</table>
331&nbsp;<table class="detail">
332<tr class="list">
333<td class="itemcode"><a name="dcb_OutxCtsFlow"></a><code><b>dcb_OutxCtsFlow</b> = $00000004;</code></td>
334</tr>
335</table>
336&nbsp;<table class="detail">
337<tr class="list">
338<td class="itemcode"><a name="dcb_OutxDsrFlow"></a><code><b>dcb_OutxDsrFlow</b> = $00000008;</code></td>
339</tr>
340</table>
341&nbsp;<table class="detail">
342<tr class="list">
343<td class="itemcode"><a name="dcb_DtrControlMask"></a><code><b>dcb_DtrControlMask</b> = $00000030;</code></td>
344</tr>
345</table>
346&nbsp;<table class="detail">
347<tr class="list">
348<td class="itemcode"><a name="dcb_DtrControlDisable"></a><code><b>dcb_DtrControlDisable</b> = $00000000;</code></td>
349</tr>
350</table>
351&nbsp;<table class="detail">
352<tr class="list">
353<td class="itemcode"><a name="dcb_DtrControlEnable"></a><code><b>dcb_DtrControlEnable</b> = $00000010;</code></td>
354</tr>
355</table>
356&nbsp;<table class="detail">
357<tr class="list">
358<td class="itemcode"><a name="dcb_DtrControlHandshake"></a><code><b>dcb_DtrControlHandshake</b> = $00000020;</code></td>
359</tr>
360</table>
361&nbsp;<table class="detail">
362<tr class="list">
363<td class="itemcode"><a name="dcb_DsrSensivity"></a><code><b>dcb_DsrSensivity</b> = $00000040;</code></td>
364</tr>
365</table>
366&nbsp;<table class="detail">
367<tr class="list">
368<td class="itemcode"><a name="dcb_TXContinueOnXoff"></a><code><b>dcb_TXContinueOnXoff</b> = $00000080;</code></td>
369</tr>
370</table>
371&nbsp;<table class="detail">
372<tr class="list">
373<td class="itemcode"><a name="dcb_OutX"></a><code><b>dcb_OutX</b> = $00000100;</code></td>
374</tr>
375</table>
376&nbsp;<table class="detail">
377<tr class="list">
378<td class="itemcode"><a name="dcb_InX"></a><code><b>dcb_InX</b> = $00000200;</code></td>
379</tr>
380</table>
381&nbsp;<table class="detail">
382<tr class="list">
383<td class="itemcode"><a name="dcb_ErrorChar"></a><code><b>dcb_ErrorChar</b> = $00000400;</code></td>
384</tr>
385</table>
386&nbsp;<table class="detail">
387<tr class="list">
388<td class="itemcode"><a name="dcb_NullStrip"></a><code><b>dcb_NullStrip</b> = $00000800;</code></td>
389</tr>
390</table>
391&nbsp;<table class="detail">
392<tr class="list">
393<td class="itemcode"><a name="dcb_RtsControlMask"></a><code><b>dcb_RtsControlMask</b> = $00003000;</code></td>
394</tr>
395</table>
396&nbsp;<table class="detail">
397<tr class="list">
398<td class="itemcode"><a name="dcb_RtsControlDisable"></a><code><b>dcb_RtsControlDisable</b> = $00000000;</code></td>
399</tr>
400</table>
401&nbsp;<table class="detail">
402<tr class="list">
403<td class="itemcode"><a name="dcb_RtsControlEnable"></a><code><b>dcb_RtsControlEnable</b> = $00001000;</code></td>
404</tr>
405</table>
406&nbsp;<table class="detail">
407<tr class="list">
408<td class="itemcode"><a name="dcb_RtsControlHandshake"></a><code><b>dcb_RtsControlHandshake</b> = $00002000;</code></td>
409</tr>
410</table>
411&nbsp;<table class="detail">
412<tr class="list">
413<td class="itemcode"><a name="dcb_RtsControlToggle"></a><code><b>dcb_RtsControlToggle</b> = $00003000;</code></td>
414</tr>
415</table>
416&nbsp;<table class="detail">
417<tr class="list">
418<td class="itemcode"><a name="dcb_AbortOnError"></a><code><b>dcb_AbortOnError</b> = $00004000;</code></td>
419</tr>
420</table>
421&nbsp;<table class="detail">
422<tr class="list">
423<td class="itemcode"><a name="dcb_Reserveds"></a><code><b>dcb_Reserveds</b> = $FFFF8000;</code></td>
424</tr>
425</table>
426&nbsp;<table class="detail">
427<tr class="list">
428<td class="itemcode"><a name="SB1"></a><code><b>SB1</b> = 0;</code></td>
429</tr>
430</table>
431<p>
432stopbit value for 1 stopbit</p>
433<table class="detail">
434<tr class="list">
435<td class="itemcode"><a name="SB1andHalf"></a><code><b>SB1andHalf</b> = 1;</code></td>
436</tr>
437</table>
438<p>
439stopbit value for 1.5 stopbit</p>
440<table class="detail">
441<tr class="list">
442<td class="itemcode"><a name="SB2"></a><code><b>SB2</b> = 2;</code></td>
443</tr>
444</table>
445<p>
446stopbit value for 2 stopbits</p>
447<table class="detail">
448<tr class="list">
449<td class="itemcode"><a name="sOK"></a><code><b>sOK</b> = 0;</code></td>
450</tr>
451</table>
452&nbsp;<table class="detail">
453<tr class="list">
454<td class="itemcode"><a name="sErr"></a><code><b>sErr</b> = integer(-1);</code></td>
455</tr>
456</table>
457&nbsp;<hr noshade size="1"><span class="appinfo"><em>Generated by <a target="_parent" href="http://pasdoc.sourceforge.net/">PasDoc 0.9.0</a> on 2012-04-23 21:38:52</em>
458</span>
459</body></html>
Note: See TracBrowser for help on using the repository browser.