summaryrefslogtreecommitdiffstats
path: root/include/libimobiledevice/libimobiledevice.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libimobiledevice/libimobiledevice.h')
-rw-r--r--include/libimobiledevice/libimobiledevice.h22
1 files changed, 11 insertions, 11 deletions
diff --git a/include/libimobiledevice/libimobiledevice.h b/include/libimobiledevice/libimobiledevice.h
index 6a349f8..016cadb 100644
--- a/include/libimobiledevice/libimobiledevice.h
+++ b/include/libimobiledevice/libimobiledevice.h
@@ -11,15 +11,15 @@
11 * modify it under the terms of the GNU Lesser General Public 11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either 12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version. 13 * version 2.1 of the License, or (at your option) any later version.
14 * 14 *
15 * This library is distributed in the hope that it will be useful, 15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details. 18 * Lesser General Public License for more details.
19 * 19 *
20 * You should have received a copy of the GNU Lesser General Public 20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software 21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 */ 23 */
24 24
25#ifndef IMOBILEDEVICE_H 25#ifndef IMOBILEDEVICE_H
@@ -122,7 +122,7 @@ idevice_error_t idevice_get_device_list(char ***devices, int *count);
122idevice_error_t idevice_device_list_free(char **devices); 122idevice_error_t idevice_device_list_free(char **devices);
123 123
124/* device structure creation and destruction */ 124/* device structure creation and destruction */
125 125
126/** 126/**
127 * Creates an idevice_t structure for the device specified by udid, 127 * Creates an idevice_t structure for the device specified by udid,
128 * if the device is available. 128 * if the device is available.
@@ -148,7 +148,7 @@ idevice_error_t idevice_new(idevice_t *device, const char *udid);
148idevice_error_t idevice_free(idevice_t device); 148idevice_error_t idevice_free(idevice_t device);
149 149
150/* connection/disconnection */ 150/* connection/disconnection */
151 151
152/** 152/**
153 * Set up a connection to the given device. 153 * Set up a connection to the given device.
154 * 154 *
@@ -171,7 +171,7 @@ idevice_error_t idevice_connect(idevice_t device, uint16_t port, idevice_connect
171idevice_error_t idevice_disconnect(idevice_connection_t connection); 171idevice_error_t idevice_disconnect(idevice_connection_t connection);
172 172
173/* communication */ 173/* communication */
174 174
175/** 175/**
176 * Send data to a device via the given connection. 176 * Send data to a device via the given connection.
177 * 177 *
@@ -201,7 +201,7 @@ idevice_error_t idevice_connection_send(idevice_connection_t connection, const c
201 * @return IDEVICE_E_SUCCESS if ok, otherwise an error code. 201 * @return IDEVICE_E_SUCCESS if ok, otherwise an error code.
202 */ 202 */
203idevice_error_t idevice_connection_receive_timeout(idevice_connection_t connection, char *data, uint32_t len, uint32_t *recv_bytes, unsigned int timeout); 203idevice_error_t idevice_connection_receive_timeout(idevice_connection_t connection, char *data, uint32_t len, uint32_t *recv_bytes, unsigned int timeout);
204 204
205/** 205/**
206 * Receive data from a device via the given connection. 206 * Receive data from a device via the given connection.
207 * This function is like idevice_connection_receive_timeout, but with a 207 * This function is like idevice_connection_receive_timeout, but with a
@@ -216,7 +216,7 @@ idevice_error_t idevice_connection_receive_timeout(idevice_connection_t connecti
216 * @return IDEVICE_E_SUCCESS if ok, otherwise an error code. 216 * @return IDEVICE_E_SUCCESS if ok, otherwise an error code.
217 */ 217 */
218idevice_error_t idevice_connection_receive(idevice_connection_t connection, char *data, uint32_t len, uint32_t *recv_bytes); 218idevice_error_t idevice_connection_receive(idevice_connection_t connection, char *data, uint32_t len, uint32_t *recv_bytes);
219 219
220/** 220/**
221 * Enables SSL for the given connection. 221 * Enables SSL for the given connection.
222 * 222 *
@@ -227,7 +227,7 @@ idevice_error_t idevice_connection_receive(idevice_connection_t connection, char
227 * SSL initialization, setup, or handshake fails. 227 * SSL initialization, setup, or handshake fails.
228 */ 228 */
229idevice_error_t idevice_connection_enable_ssl(idevice_connection_t connection); 229idevice_error_t idevice_connection_enable_ssl(idevice_connection_t connection);
230 230
231/** 231/**
232 * Disable SSL for the given connection. 232 * Disable SSL for the given connection.
233 * 233 *
@@ -240,12 +240,12 @@ idevice_error_t idevice_connection_enable_ssl(idevice_connection_t connection);
240idevice_error_t idevice_connection_disable_ssl(idevice_connection_t connection); 240idevice_error_t idevice_connection_disable_ssl(idevice_connection_t connection);
241 241
242/* misc */ 242/* misc */
243 243
244/** 244/**
245 * Gets the handle of the device. Depends on the connection type. 245 * Gets the handle of the device. Depends on the connection type.
246 */ 246 */
247idevice_error_t idevice_get_handle(idevice_t device, uint32_t *handle); 247idevice_error_t idevice_get_handle(idevice_t device, uint32_t *handle);
248 248
249/** 249/**
250 * Gets the unique id for the device. 250 * Gets the unique id for the device.
251 */ 251 */