File: probe.c.html

package info (click to toggle)
libticables 1.3.4%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 3,352 kB
  • ctags: 2,309
  • sloc: sh: 11,957; ansic: 11,866; makefile: 153; sed: 16
file content (146 lines) | stat: -rw-r--r-- 4,191 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<html>
<head>
<title>Header File Index</title>
<link rel="STYLESHEET" type="TEXT/CSS" href="style.css">
</head>
<body bgcolor="#fffff8">
<table class="INVTABLE" width="100%">
<tbody>
<tr>
<td class="NOBORDER" width="40"><img src="info.gif" border="0"
height="32" width="32"> </td>
<td class="TITLE">Automatic probing of cables<br>
</td>
</tr>
</tbody>
</table>
<hr>
<h3><a name="ticables_probing_do"></a>ticables_probing_do</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 int TICALL ticables_probing_do(int ***result, int timeout, ProbingMethod method)
</td>
</tr>
</tbody>
</table>
<br>
Returns cables which have been detected. All cables should be closed before !
The array is like a matrix which contains 5 columns (PORT_0 to PORT_4) and 
7 lines (CABLE_GRY to CABLE_USB).
The array must be freed by #ticables_probing_finish when no longer used.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">result :<br></td>
<td style="vertical-align: top;">address of an array of integers to put the result.
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">timeout :<br></td>
<td style="vertical-align: top;">timeout to set during probing
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">method :<br></td>
<td style="vertical-align: top;">defines which link cables you want to search for.
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">0 if successful, ERR_NO_CABLE if no cables found.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_probing_finish"></a>ticables_probing_finish</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 int TICALL ticables_probing_finish(int ***result)
</td>
</tr>
</tbody>
</table>
<br>
Free the array created by #ticables_probing_do.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">result :<br></td>
<td style="vertical-align: top;">address of an array of integers. 
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">always 0.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_is_usb_enabled"></a>ticables_is_usb_enabled</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 int TICALL ticables_is_usb_enabled(void)
</td>
</tr>
</tbody>
</table>
<br>
Checks whether USB support is available. Can be called at any time.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">!0 if available, 0 otherwise.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_get_usb_devices"></a>ticables_get_usb_devices</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 int TICALL ticables_get_usb_devices(int **list, int *len)
</td>
</tr>
</tbody>
</table>
<br>
Returns the list of detected USB PIDs. Note that list is in the 
same order as PORT#x.
The array must be freed when no longer used.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">array :<br></td>
<td style="vertical-align: top;">address of a NULL-terminated allocated array of integers (PIDs).
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">length :<br></td>
<td style="vertical-align: top;">number of detected USB devices.
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">0 if successful, an error code otherwise.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a href="file:index.html">Return to the main index</a> </h3><br><br><br></body>
</html>