~ubuntu-branches/ubuntu/wily/libimobiledevice/wily

« back to all changes in this revision

Viewing changes to docs/html/include_2libimobiledevice_2mobilesync_8h.html

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2010-05-24 23:39:58 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100524233958-vljg2n4w7pqim0vj
* New upstream release.
* debian/watch: Update.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
 
<html xmlns="http://www.w3.org/1999/xhtml">
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
5
3
<title>libimobiledevice: libimobiledevice/mobilesync.h File Reference</title>
6
 
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
 
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
 
</head>
9
 
<body>
10
 
<!-- Generated by Doxygen 1.6.1 -->
 
4
<link href="tabs.css" rel="stylesheet" type="text/css">
 
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.9 -->
11
8
<div class="navigation" id="top">
12
9
  <div class="tabs">
13
10
    <ul>
24
21
  </div>
25
22
</div>
26
23
<div class="contents">
27
 
<h1>libimobiledevice/mobilesync.h File Reference</h1>
28
 
<p>MobileSync Implementation.  
29
 
<a href="#_details">More...</a></p>
 
24
<h1>libimobiledevice/mobilesync.h File Reference</h1>MobileSync Implementation.  
 
25
<a href="#_details">More...</a>
 
26
<p>
30
27
<table border="0" cellpadding="0" cellspacing="0">
31
 
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
32
 
<tr><td class="memItemLeft" align="right" valign="top">typedef int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a></td></tr>
33
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents an error code.  <a href="#a860c449a8dc2d56bcbcfdb44bfc79b6f"></a><br/></td></tr>
34
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9416410eb63a6f40c144f5e13576650"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::mobilesync_client_t" ref="ae9416410eb63a6f40c144f5e13576650" args="" -->
35
 
typedef <a class="el" href="structmobilesync__client__private.html">mobilesync_client_private</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a></td></tr>
36
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The client handle. <br/></td></tr>
37
 
<tr><td colspan="2"><h2>Functions</h2></td></tr>
38
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#ab70c2c3ec18a6bd654ecd2792564c4f6">mobilesync_client_new</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, uint16_t port, <a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a> *client)</td></tr>
39
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connects to the mobilesync service on the specified device.  <a href="#ab70c2c3ec18a6bd654ecd2792564c4f6"></a><br/></td></tr>
40
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a684e78bdb59be1169217f3e9d7fbc2da">mobilesync_client_free</a> (<a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a> client)</td></tr>
41
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disconnects a mobilesync client from the device and frees up the mobilesync client data.  <a href="#a684e78bdb59be1169217f3e9d7fbc2da"></a><br/></td></tr>
42
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a85d593631f8dddd7f58691c7351a1f44">mobilesync_receive</a> (<a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a> client, plist_t *plist)</td></tr>
43
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Polls the device for mobilesync data.  <a href="#a85d593631f8dddd7f58691c7351a1f44"></a><br/></td></tr>
44
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a76e54260a77572f07327cbc17d805533">mobilesync_send</a> (<a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a> client, plist_t plist)</td></tr>
45
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends mobilesync data to the device.  <a href="#a76e54260a77572f07327cbc17d805533"></a><br/></td></tr>
46
 
<tr><td colspan="2"><h2>Error Codes</h2></td></tr>
47
 
<tr><td colspan="2"><p><a class="anchor" id="amgrp5c244138ac975df1b1cec1afc71a6c9a"></a> </p>
48
 
<br/><br/></td></tr>
49
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac67494bfbaa06ccbe2d099cc5bf92f5e"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_SUCCESS" ref="ac67494bfbaa06ccbe2d099cc5bf92f5e" args="" -->
 
28
<tr><td></td></tr>
 
29
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
 
30
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a></td></tr>
 
31
 
 
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Represents an error code.  <a href="#860c449a8dc2d56bcbcfdb44bfc79b6f"></a><br></td></tr>
 
33
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9416410eb63a6f40c144f5e13576650"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::mobilesync_client_t" ref="e9416410eb63a6f40c144f5e13576650" args="" -->
 
34
typedef mobilesync_client_private *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#e9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a></td></tr>
 
35
 
 
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The client handle. <br></td></tr>
 
37
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 
38
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#b70c2c3ec18a6bd654ecd2792564c4f6">mobilesync_client_new</a> (<a class="el" href="libimobiledevice_8h.html#e5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, uint16_t port, <a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#e9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> *client)</td></tr>
 
39
 
 
40
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connects to the mobilesync service on the specified device.  <a href="#b70c2c3ec18a6bd654ecd2792564c4f6"></a><br></td></tr>
 
41
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#684e78bdb59be1169217f3e9d7fbc2da">mobilesync_client_free</a> (<a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#e9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client)</td></tr>
 
42
 
 
43
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disconnects a mobilesync client from the device and frees up the mobilesync client data.  <a href="#684e78bdb59be1169217f3e9d7fbc2da"></a><br></td></tr>
 
44
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#85d593631f8dddd7f58691c7351a1f44">mobilesync_receive</a> (<a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#e9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client, plist_t *plist)</td></tr>
 
45
 
 
46
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Polls the device for mobilesync data.  <a href="#85d593631f8dddd7f58691c7351a1f44"></a><br></td></tr>
 
47
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#76e54260a77572f07327cbc17d805533">mobilesync_send</a> (<a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#e9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client, plist_t plist)</td></tr>
 
48
 
 
49
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends mobilesync data to the device.  <a href="#76e54260a77572f07327cbc17d805533"></a><br></td></tr>
 
50
<tr><td colspan="2"><br><h2>Error Codes</h2></td></tr>
 
51
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c67494bfbaa06ccbe2d099cc5bf92f5e"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_SUCCESS" ref="c67494bfbaa06ccbe2d099cc5bf92f5e" args="" -->
50
52
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_SUCCESS</b>&nbsp;&nbsp;&nbsp;0</td></tr>
51
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa043d3bfc00b54545d2869abd5cf4778"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_INVALID_ARG" ref="aa043d3bfc00b54545d2869abd5cf4778" args="" -->
 
53
 
 
54
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a043d3bfc00b54545d2869abd5cf4778"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_INVALID_ARG" ref="a043d3bfc00b54545d2869abd5cf4778" args="" -->
52
55
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_INVALID_ARG</b>&nbsp;&nbsp;&nbsp;-1</td></tr>
53
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9c0edcc3c6da516add09b61d19b29cf"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_PLIST_ERROR" ref="ad9c0edcc3c6da516add09b61d19b29cf" args="" -->
 
56
 
 
57
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9c0edcc3c6da516add09b61d19b29cf"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_PLIST_ERROR" ref="d9c0edcc3c6da516add09b61d19b29cf" args="" -->
54
58
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_PLIST_ERROR</b>&nbsp;&nbsp;&nbsp;-2</td></tr>
55
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0337b6d09683a5c56d9bce0aff532136"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_MUX_ERROR" ref="a0337b6d09683a5c56d9bce0aff532136" args="" -->
 
59
 
 
60
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0337b6d09683a5c56d9bce0aff532136"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_MUX_ERROR" ref="0337b6d09683a5c56d9bce0aff532136" args="" -->
56
61
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_MUX_ERROR</b>&nbsp;&nbsp;&nbsp;-3</td></tr>
57
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab45959745dd9125082275d978e91f252"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_BAD_VERSION" ref="ab45959745dd9125082275d978e91f252" args="" -->
 
62
 
 
63
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b45959745dd9125082275d978e91f252"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_BAD_VERSION" ref="b45959745dd9125082275d978e91f252" args="" -->
58
64
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_BAD_VERSION</b>&nbsp;&nbsp;&nbsp;-4</td></tr>
59
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45a511c0d72bc83582952aeaf5110374"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_UNKNOWN_ERROR" ref="a45a511c0d72bc83582952aeaf5110374" args="" -->
 
65
 
 
66
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="45a511c0d72bc83582952aeaf5110374"></a><!-- doxytag: member="include/libimobiledevice/mobilesync.h::MOBILESYNC_E_UNKNOWN_ERROR" ref="45a511c0d72bc83582952aeaf5110374" args="" -->
60
67
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_UNKNOWN_ERROR</b>&nbsp;&nbsp;&nbsp;-256</td></tr>
 
68
 
61
69
</table>
62
 
<hr/><a name="_details"></a><h2>Detailed Description</h2>
63
 
<p>MobileSync Implementation. </p>
64
 
<hr/><h2>Typedef Documentation</h2>
65
 
<a class="anchor" id="a860c449a8dc2d56bcbcfdb44bfc79b6f"></a><!-- doxytag: member="mobilesync.h::mobilesync_error_t" ref="a860c449a8dc2d56bcbcfdb44bfc79b6f" args="" -->
 
70
<hr><h2>Detailed Description</h2>
 
71
MobileSync Implementation. 
 
72
<p>
 
73
<hr><h2>Typedef Documentation</h2>
 
74
<a class="anchor" name="860c449a8dc2d56bcbcfdb44bfc79b6f"></a><!-- doxytag: member="mobilesync.h::mobilesync_error_t" ref="860c449a8dc2d56bcbcfdb44bfc79b6f" args="" -->
66
75
<div class="memitem">
67
76
<div class="memproto">
68
77
      <table class="memname">
69
78
        <tr>
70
 
          <td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a></td>
 
79
          <td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a>          </td>
71
80
        </tr>
72
81
      </table>
73
82
</div>
74
83
<div class="memdoc">
75
84
 
76
 
<p>Represents an error code. </p>
 
85
<p>
 
86
Represents an error code. 
 
87
<p>
77
88
 
78
89
</div>
79
 
</div>
80
 
<hr/><h2>Function Documentation</h2>
81
 
<a class="anchor" id="a684e78bdb59be1169217f3e9d7fbc2da"></a><!-- doxytag: member="mobilesync.h::mobilesync_client_free" ref="a684e78bdb59be1169217f3e9d7fbc2da" args="(mobilesync_client_t client)" -->
 
90
</div><p>
 
91
<hr><h2>Function Documentation</h2>
 
92
<a class="anchor" name="684e78bdb59be1169217f3e9d7fbc2da"></a><!-- doxytag: member="mobilesync.h::mobilesync_client_free" ref="684e78bdb59be1169217f3e9d7fbc2da" args="(mobilesync_client_t client)" -->
82
93
<div class="memitem">
83
94
<div class="memproto">
84
95
      <table class="memname">
85
96
        <tr>
86
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_client_free </td>
 
97
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_client_free           </td>
87
98
          <td>(</td>
88
 
          <td class="paramtype"><a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a>&nbsp;</td>
89
 
          <td class="paramname"> <em>client</em></td>
 
99
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#e9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a>&nbsp;</td>
 
100
          <td class="paramname"> <em>client</em>          </td>
90
101
          <td>&nbsp;)&nbsp;</td>
91
102
          <td></td>
92
103
        </tr>
94
105
</div>
95
106
<div class="memdoc">
96
107
 
97
 
<p>Disconnects a mobilesync client from the device and frees up the mobilesync client data. </p>
98
 
<dl><dt><b>Parameters:</b></dt><dd>
 
108
<p>
 
109
Disconnects a mobilesync client from the device and frees up the mobilesync client data. 
 
110
<p>
 
111
<dl compact><dt><b>Parameters:</b></dt><dd>
99
112
  <table border="0" cellspacing="2" cellpadding="0">
100
113
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The mobilesync client to disconnect and free.</td></tr>
101
114
  </table>
102
 
  </dd>
103
115
</dl>
104
 
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILESYNC_E_SUCCESS on success, or MOBILESYNC_E_INVALID_ARG if client is NULL. </dd></dl>
 
116
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MOBILESYNC_E_SUCCESS on success, or MOBILESYNC_E_INVALID_ARG if client is NULL. </dd></dl>
105
117
 
106
118
</div>
107
 
</div>
108
 
<a class="anchor" id="ab70c2c3ec18a6bd654ecd2792564c4f6"></a><!-- doxytag: member="mobilesync.h::mobilesync_client_new" ref="ab70c2c3ec18a6bd654ecd2792564c4f6" args="(idevice_t device, uint16_t port, mobilesync_client_t *client)" -->
 
119
</div><p>
 
120
<a class="anchor" name="b70c2c3ec18a6bd654ecd2792564c4f6"></a><!-- doxytag: member="mobilesync.h::mobilesync_client_new" ref="b70c2c3ec18a6bd654ecd2792564c4f6" args="(idevice_t device, uint16_t port, mobilesync_client_t *client)" -->
109
121
<div class="memitem">
110
122
<div class="memproto">
111
123
      <table class="memname">
112
124
        <tr>
113
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_client_new </td>
 
125
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_client_new           </td>
114
126
          <td>(</td>
115
 
          <td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a>&nbsp;</td>
 
127
          <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#e5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&nbsp;</td>
116
128
          <td class="paramname"> <em>device</em>, </td>
117
129
        </tr>
118
130
        <tr>
124
136
        <tr>
125
137
          <td class="paramkey"></td>
126
138
          <td></td>
127
 
          <td class="paramtype"><a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a> *&nbsp;</td>
 
139
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#e9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> *&nbsp;</td>
128
140
          <td class="paramname"> <em>client</em></td><td>&nbsp;</td>
129
141
        </tr>
130
142
        <tr>
136
148
</div>
137
149
<div class="memdoc">
138
150
 
139
 
<p>Connects to the mobilesync service on the specified device. </p>
140
 
<dl><dt><b>Parameters:</b></dt><dd>
 
151
<p>
 
152
Connects to the mobilesync service on the specified device. 
 
153
<p>
 
154
<dl compact><dt><b>Parameters:</b></dt><dd>
141
155
  <table border="0" cellspacing="2" cellpadding="0">
142
156
    <tr><td valign="top"></td><td valign="top"><em>device</em>&nbsp;</td><td>The device to connect to. </td></tr>
143
157
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
144
158
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>Pointer that will be set to a newly allocated mobilesync_client_t upon successful return.</td></tr>
145
159
  </table>
146
 
  </dd>
147
160
</dl>
148
 
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILESYNC_E_SUCCESS on success, MOBILESYNC_E_INVALID ARG if one or more parameters are invalid, or DEVICE_LINK_SERVICE_E_BAD_VERSION if the mobilesync version on the device is newer. </dd></dl>
 
161
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MOBILESYNC_E_SUCCESS on success, MOBILESYNC_E_INVALID ARG if one or more parameters are invalid, or DEVICE_LINK_SERVICE_E_BAD_VERSION if the mobilesync version on the device is newer. </dd></dl>
149
162
 
150
163
</div>
151
 
</div>
152
 
<a class="anchor" id="a85d593631f8dddd7f58691c7351a1f44"></a><!-- doxytag: member="mobilesync.h::mobilesync_receive" ref="a85d593631f8dddd7f58691c7351a1f44" args="(mobilesync_client_t client, plist_t *plist)" -->
 
164
</div><p>
 
165
<a class="anchor" name="85d593631f8dddd7f58691c7351a1f44"></a><!-- doxytag: member="mobilesync.h::mobilesync_receive" ref="85d593631f8dddd7f58691c7351a1f44" args="(mobilesync_client_t client, plist_t *plist)" -->
153
166
<div class="memitem">
154
167
<div class="memproto">
155
168
      <table class="memname">
156
169
        <tr>
157
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_receive </td>
 
170
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_receive           </td>
158
171
          <td>(</td>
159
 
          <td class="paramtype"><a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a>&nbsp;</td>
 
172
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#e9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a>&nbsp;</td>
160
173
          <td class="paramname"> <em>client</em>, </td>
161
174
        </tr>
162
175
        <tr>
174
187
</div>
175
188
<div class="memdoc">
176
189
 
177
 
<p>Polls the device for mobilesync data. </p>
178
 
<dl><dt><b>Parameters:</b></dt><dd>
 
190
<p>
 
191
Polls the device for mobilesync data. 
 
192
<p>
 
193
<dl compact><dt><b>Parameters:</b></dt><dd>
179
194
  <table border="0" cellspacing="2" cellpadding="0">
180
195
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The mobilesync client </td></tr>
181
196
    <tr><td valign="top"></td><td valign="top"><em>plist</em>&nbsp;</td><td>A pointer to the location where the plist should be stored</td></tr>
182
197
  </table>
183
 
  </dd>
184
198
</dl>
185
 
<dl class="return"><dt><b>Returns:</b></dt><dd>an error code </dd></dl>
 
199
<dl class="return" compact><dt><b>Returns:</b></dt><dd>an error code </dd></dl>
186
200
 
187
201
</div>
188
 
</div>
189
 
<a class="anchor" id="a76e54260a77572f07327cbc17d805533"></a><!-- doxytag: member="mobilesync.h::mobilesync_send" ref="a76e54260a77572f07327cbc17d805533" args="(mobilesync_client_t client, plist_t plist)" -->
 
202
</div><p>
 
203
<a class="anchor" name="76e54260a77572f07327cbc17d805533"></a><!-- doxytag: member="mobilesync.h::mobilesync_send" ref="76e54260a77572f07327cbc17d805533" args="(mobilesync_client_t client, plist_t plist)" -->
190
204
<div class="memitem">
191
205
<div class="memproto">
192
206
      <table class="memname">
193
207
        <tr>
194
 
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_send </td>
 
208
          <td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_send           </td>
195
209
          <td>(</td>
196
 
          <td class="paramtype"><a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a>&nbsp;</td>
 
210
          <td class="paramtype"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#e9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a>&nbsp;</td>
197
211
          <td class="paramname"> <em>client</em>, </td>
198
212
        </tr>
199
213
        <tr>
211
225
</div>
212
226
<div class="memdoc">
213
227
 
214
 
<p>Sends mobilesync data to the device. </p>
215
 
<dl class="note"><dt><b>Note:</b></dt><dd>This function is low-level and should only be used if you need to send a new type of message.</dd></dl>
216
 
<dl><dt><b>Parameters:</b></dt><dd>
 
228
<p>
 
229
Sends mobilesync data to the device. 
 
230
<p>
 
231
<dl class="note" compact><dt><b>Note:</b></dt><dd>This function is low-level and should only be used if you need to send a new type of message.</dd></dl>
 
232
<dl compact><dt><b>Parameters:</b></dt><dd>
217
233
  <table border="0" cellspacing="2" cellpadding="0">
218
234
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The mobilesync client </td></tr>
219
235
    <tr><td valign="top"></td><td valign="top"><em>plist</em>&nbsp;</td><td>The location of the plist to send</td></tr>
220
236
  </table>
221
 
  </dd>
222
237
</dl>
223
 
<dl class="return"><dt><b>Returns:</b></dt><dd>an error code </dd></dl>
 
238
<dl class="return" compact><dt><b>Returns:</b></dt><dd>an error code </dd></dl>
224
239
 
225
240
</div>
226
 
</div>
227
 
</div>
228
 
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Mar 21 09:43:44 2010 for libimobiledevice by&nbsp;
229
 
<a href="http://www.doxygen.org/index.html">
230
 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
 
241
</div><p>
 
242
</div>
 
243
<hr size="1"><address style="text-align: right;"><small><a href="http://www.doxygen.org/index.html">
 
244
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> </small></address>
231
245
</body>
232
246
</html>