<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libimobiledevice: libimobiledevice/mobilesync.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libimobiledevice <span id="projectnumber">1.0.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>libimobiledevice/mobilesync.h File Reference</h1> </div>
</div>
<div class="contents">
<p>MobileSync Implementation.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Represents an error code. <a href="#a860c449a8dc2d56bcbcfdb44bfc79b6f"></a><br/></td></tr>
<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="" -->
typedef <a class="el" href="structmobilesync__client__private.html">mobilesync_client_private</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> </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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the mobilesync service on the specified device. <a href="#ab70c2c3ec18a6bd654ecd2792564c4f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> </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>
<tr><td class="mdescLeft"> </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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> </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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Polls the device for mobilesync data. <a href="#a85d593631f8dddd7f58691c7351a1f44"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> </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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends mobilesync data to the device. <a href="#a76e54260a77572f07327cbc17d805533"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="member-group"></a>
Error Codes</h2></td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_SUCCESS</b>   0</td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_INVALID_ARG</b>   -1</td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_PLIST_ERROR</b>   -2</td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_MUX_ERROR</b>   -3</td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_BAD_VERSION</b>   -4</td></tr>
<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="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_E_UNKNOWN_ERROR</b>   -256</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>MobileSync Implementation. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a860c449a8dc2d56bcbcfdb44bfc79b6f"></a><!-- doxytag: member="mobilesync.h::mobilesync_error_t" ref="a860c449a8dc2d56bcbcfdb44bfc79b6f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Represents an error code. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a684e78bdb59be1169217f3e9d7fbc2da"></a><!-- doxytag: member="mobilesync.h::mobilesync_client_free" ref="a684e78bdb59be1169217f3e9d7fbc2da" args="(mobilesync_client_t client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_client_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a> </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disconnects a mobilesync client from the device and frees up the mobilesync client data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The mobilesync client to disconnect and free.</td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_client_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structidevice__private.html">idevice_t</a> </td>
<td class="paramname"><em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a> * </td>
<td class="paramname"><em>client</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects to the mobilesync service on the specified device. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
<tr><td class="paramname">port</td><td>Destination port (usually given by lockdownd_start_service). </td></tr>
<tr><td class="paramname">client</td><td>Pointer that will be set to a newly allocated mobilesync_client_t upon successful return.</td></tr>
</table>
</dd>
</dl>
<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>
</div>
</div>
<a class="anchor" id="a85d593631f8dddd7f58691c7351a1f44"></a><!-- doxytag: member="mobilesync.h::mobilesync_receive" ref="a85d593631f8dddd7f58691c7351a1f44" args="(mobilesync_client_t client, plist_t *plist)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_receive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">plist_t * </td>
<td class="paramname"><em>plist</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Polls the device for mobilesync data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The mobilesync client </td></tr>
<tr><td class="paramname">plist</td><td>A pointer to the location where the plist should be stored</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an error code </dd></dl>
</div>
</div>
<a class="anchor" id="a76e54260a77572f07327cbc17d805533"></a><!-- doxytag: member="mobilesync.h::mobilesync_send" ref="a76e54260a77572f07327cbc17d805533" args="(mobilesync_client_t client, plist_t plist)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2mobilesync_8h.html#a860c449a8dc2d56bcbcfdb44bfc79b6f">mobilesync_error_t</a> mobilesync_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmobilesync__client__private.html">mobilesync_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">plist_t </td>
<td class="paramname"><em>plist</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends mobilesync data to the device. </p>
<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>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The mobilesync client </td></tr>
<tr><td class="paramname">plist</td><td>The location of the plist to send</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an error code </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
