<!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/mobilebackup.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/mobilebackup.h File Reference</h1> </div>
</div>
<div class="contents">
<p>MobileBackup 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_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Represents an error code. <a href="#aa02643157eaacc46ff4c5e40b83319a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
<a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_private</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a80c8c3310e73ac1ac6cdb565635a9af8"></a><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_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#ae55b7f0bf07aa841db272ba2ea4801e0">mobilebackup_client_new</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, uint16_t port, <a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> *client)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to the mobilebackup service on the specified device. <a href="#ae55b7f0bf07aa841db272ba2ea4801e0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aceff0d79d743e3b9e2974ef1ff298c6f">mobilebackup_client_free</a> (<a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> client)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnects a mobilebackup client from the device and frees up the mobilebackup client data. <a href="#aceff0d79d743e3b9e2974ef1ff298c6f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#ab141879e1be237c2b3e3b739fe31b6b5">mobilebackup_receive</a> (<a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> client, plist_t *plist)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Polls the device for mobilebackup data. <a href="#ab141879e1be237c2b3e3b739fe31b6b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#a868886fd24134178fea043e5cbaa3a75">mobilebackup_send</a> (<a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> client, plist_t plist)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends mobilebackup data to the device. <a href="#a868886fd24134178fea043e5cbaa3a75"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#a22a4ffba65451178d42251643edf7cb8">mobilebackup_request_backup</a> (<a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> client, plist_t backup_manifest, const char *base_path, const char *proto_version)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a backup from the connected device. <a href="#a22a4ffba65451178d42251643edf7cb8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#a684dd7ebb0111f8a8ca7ab4119199be9">mobilebackup_send_backup_file_received</a> (<a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> client)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a confirmation to the device that a backup file has been received. <a href="#a684dd7ebb0111f8a8ca7ab4119199be9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#a68249f2d882e0264bdd45ea2abf1e6d1">mobilebackup_send_error</a> (<a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> client, const char *reason)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a backup error message to the device. <a href="#a68249f2d882e0264bdd45ea2abf1e6d1"></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="a82a766e94c793fefadebc9bac2766a19"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup.h::MOBILEBACKUP_E_SUCCESS" ref="a82a766e94c793fefadebc9bac2766a19" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP_E_SUCCESS</b>   0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9ebbf315d46420ecf4c6bdc537fb012"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup.h::MOBILEBACKUP_E_INVALID_ARG" ref="ae9ebbf315d46420ecf4c6bdc537fb012" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP_E_INVALID_ARG</b>   -1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04f3e525d02d6282584e66b9a7001caa"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup.h::MOBILEBACKUP_E_PLIST_ERROR" ref="a04f3e525d02d6282584e66b9a7001caa" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP_E_PLIST_ERROR</b>   -2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f6051e71f382ab56cbfc986350a5ce9"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup.h::MOBILEBACKUP_E_MUX_ERROR" ref="a3f6051e71f382ab56cbfc986350a5ce9" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP_E_MUX_ERROR</b>   -3</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a20052a303f57356ba3d5641c2df5ee"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup.h::MOBILEBACKUP_E_BAD_VERSION" ref="a9a20052a303f57356ba3d5641c2df5ee" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP_E_BAD_VERSION</b>   -4</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a905a81babd94f85e0edd17ab300d7fcc"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup.h::MOBILEBACKUP_E_REPLY_NOT_OK" ref="a905a81babd94f85e0edd17ab300d7fcc" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP_E_REPLY_NOT_OK</b>   -5</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0fde10072c96ea4261075dabd4a20dbc"></a><!-- doxytag: member="include/libimobiledevice/mobilebackup.h::MOBILEBACKUP_E_UNKNOWN_ERROR" ref="a0fde10072c96ea4261075dabd4a20dbc" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP_E_UNKNOWN_ERROR</b>   -256</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>MobileBackup Implementation. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a80c8c3310e73ac1ac6cdb565635a9af8"></a><!-- doxytag: member="mobilebackup.h::mobilebackup_client_t" ref="a80c8c3310e73ac1ac6cdb565635a9af8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_private</a>* <a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The client handle. </p>
</div>
</div>
<a class="anchor" id="aa02643157eaacc46ff4c5e40b83319a3"></a><!-- doxytag: member="mobilebackup.h::mobilebackup_error_t" ref="aa02643157eaacc46ff4c5e40b83319a3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_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="aceff0d79d743e3b9e2974ef1ff298c6f"></a><!-- doxytag: member="mobilebackup.h::mobilebackup_client_free" ref="aceff0d79d743e3b9e2974ef1ff298c6f" args="(mobilebackup_client_t client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> mobilebackup_client_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disconnects a mobilebackup client from the device and frees up the mobilebackup client data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The mobilebackup client to disconnect and free.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP_E_SUCCESS on success, or MOBILEBACKUP_E_INVALID_ARG if client is NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="ae55b7f0bf07aa841db272ba2ea4801e0"></a><!-- doxytag: member="mobilebackup.h::mobilebackup_client_new" ref="ae55b7f0bf07aa841db272ba2ea4801e0" args="(idevice_t device, uint16_t port, mobilebackup_client_t *client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> mobilebackup_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="structmobilebackup__client__private.html">mobilebackup_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 mobilebackup 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 mobilebackup_client_t upon successful return.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID ARG if one or more parameters are invalid, or DEVICE_LINK_SERVICE_E_BAD_VERSION if the mobilebackup version on the device is newer. </dd></dl>
</div>
</div>
<a class="anchor" id="ab141879e1be237c2b3e3b739fe31b6b5"></a><!-- doxytag: member="mobilebackup.h::mobilebackup_receive" ref="ab141879e1be237c2b3e3b739fe31b6b5" args="(mobilebackup_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_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> mobilebackup_receive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmobilebackup__client__private.html">mobilebackup_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 mobilebackup data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The mobilebackup 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="a22a4ffba65451178d42251643edf7cb8"></a><!-- doxytag: member="mobilebackup.h::mobilebackup_request_backup" ref="a22a4ffba65451178d42251643edf7cb8" args="(mobilebackup_client_t client, plist_t backup_manifest, const char *base_path, const char *proto_version)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> mobilebackup_request_backup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmobilebackup__client__private.html">mobilebackup_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>backup_manifest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>base_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>proto_version</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request a backup from the connected device. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
<tr><td class="paramname">backup_manifest</td><td>The backup manifest, a plist_t of type PLIST_DICT containing the backup state of the last backup. For a first-time backup set this parameter to NULL. </td></tr>
<tr><td class="paramname">base_path</td><td>The base path on the device to use for the backup operation, usually "/". </td></tr>
<tr><td class="paramname">proto_version</td><td>A string denoting the version of the backup protocol to use. Latest known version is "1.6"</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if one of the parameters is invalid, MOBILEBACKUP_E_PLIST_ERROR if backup_manifest is not of type PLIST_DICT, MOBILEBACKUP_E_MUX_ERROR if a communication error occurs, MOBILEBACKUP_E_REPLY_NOT_OK </dd></dl>
</div>
</div>
<a class="anchor" id="a868886fd24134178fea043e5cbaa3a75"></a><!-- doxytag: member="mobilebackup.h::mobilebackup_send" ref="a868886fd24134178fea043e5cbaa3a75" args="(mobilebackup_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_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> mobilebackup_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmobilebackup__client__private.html">mobilebackup_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 mobilebackup 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 mobilebackup 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>
<a class="anchor" id="a684dd7ebb0111f8a8ca7ab4119199be9"></a><!-- doxytag: member="mobilebackup.h::mobilebackup_send_backup_file_received" ref="a684dd7ebb0111f8a8ca7ab4119199be9" args="(mobilebackup_client_t client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> mobilebackup_send_backup_file_received </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends a confirmation to the device that a backup file has been received. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The connected MobileBackup client to use.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
</div>
</div>
<a class="anchor" id="a68249f2d882e0264bdd45ea2abf1e6d1"></a><!-- doxytag: member="mobilebackup.h::mobilebackup_send_error" ref="a68249f2d882e0264bdd45ea2abf1e6d1" args="(mobilebackup_client_t client, const char *reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2mobilebackup_8h.html#aa02643157eaacc46ff4c5e40b83319a3">mobilebackup_error_t</a> mobilebackup_send_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmobilebackup__client__private.html">mobilebackup_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>reason</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends a backup error message to the device. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
<tr><td class="paramname">reason</td><td>A string describing the reason for the error message.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if one of the parameters is invalid, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </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>
