<!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/lockdown.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="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>libimobiledevice/lockdown.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Implementation to communicate with the lockdown device daemon.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structlockdownd__pair__record.html">lockdownd_pair_record_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A pair record holding device, host and root certificates along the host_id. <a href="structlockdownd__pair__record.html#_details">More...</a><br/></td></tr>
<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_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Represents an error code. <a href="#a2c5d6e126bd17d2a5c07a5829cd0da50"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structlockdownd__client__private.html">lockdownd_client_private</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a8254fd517d2303ad1208eb00d622e0f3">lockdownd_client_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <a href="#a8254fd517d2303ad1208eb00d622e0f3"></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_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#aa2ed91c7a083b6c4322840cdd9e17c7a">lockdownd_client_new</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, <a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> *client, const char *label)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new lockdownd client for the device. <a href="#aa2ed91c7a083b6c4322840cdd9e17c7a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a5af6829d41749688b92b8436eefd2853">lockdownd_client_new_with_handshake</a> (<a class="el" href="structidevice__private.html">idevice_t</a> device, <a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> *client, const char *label)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new lockdownd client for the device and starts initial handshake. <a href="#a5af6829d41749688b92b8436eefd2853"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#aa886513215f9cc696ab47696e5498904">lockdownd_client_free</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the lockdownd client session if one is running and frees up the lockdownd_client struct. <a href="#aa886513215f9cc696ab47696e5498904"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a9e94b542d55e9b78dfe8a8dbbab88ef5">lockdownd_query_type</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, char **type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the type of the service daemon. <a href="#a9e94b542d55e9b78dfe8a8dbbab88ef5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a204c585addfca987e09f8fda24a04b28">lockdownd_get_value</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, const char *domain, const char *key, plist_t *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a preferences plist using an optional domain and/or key name. <a href="#a204c585addfca987e09f8fda24a04b28"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a3aeb41a3f2243437fc87d99f5ea4aadb">lockdownd_set_value</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, const char *domain, const char *key, plist_t value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a preferences value using a plist and optional by domain and/or key name. <a href="#a3aeb41a3f2243437fc87d99f5ea4aadb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a1d1e537aec30bfb4c3e0096014deeb12">lockdownd_remove_value</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, const char *domain, const char *key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a preference node by domain and/or key name. <a href="#a1d1e537aec30bfb4c3e0096014deeb12"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a51f93594093dc6e56d978dda0e1f653b">lockdownd_start_service</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, const char *service, uint16_t *port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Requests to start a service and retrieve it's port on success. <a href="#a51f93594093dc6e56d978dda0e1f653b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a21d7159ab85f8fca0e94751e8bb8f401">lockdownd_start_session</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, const char *host_id, char **session_id, int *ssl_enabled)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens a session with lockdownd and switches to SSL mode if device wants it. <a href="#a21d7159ab85f8fca0e94751e8bb8f401"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#ad6f68455954be19911d495345390f6fb">lockdownd_stop_session</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, const char *session_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the lockdownd session by sending the StopSession request. <a href="#ad6f68455954be19911d495345390f6fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a1c1b4c2e8e01efc67ff4319be97d5668">lockdownd_send</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, plist_t plist)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a plist to lockdownd. <a href="#a1c1b4c2e8e01efc67ff4319be97d5668"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a74e4f3ea70c691e5f12f964ea1e9b42b">lockdownd_receive</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, plist_t *plist)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receives a plist from lockdownd. <a href="#a74e4f3ea70c691e5f12f964ea1e9b42b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a8df943348a5b657b613b931231681571">lockdownd_pair</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, lockdownd_pair_record_t pair_record)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pairs the device using the supplied pair record. <a href="#a8df943348a5b657b613b931231681571"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#af36157f83cb262680bbc8903fcf1ba8a">lockdownd_validate_pair</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, lockdownd_pair_record_t pair_record)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Validates if the device is paired with the given HostID. <a href="#af36157f83cb262680bbc8903fcf1ba8a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#ab9e7add76d59381e60fed8122dd30b64">lockdownd_unpair</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, lockdownd_pair_record_t pair_record)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unpairs the device with the given HostID and removes the pairing records from the device and host if the internal pairing record management is used. <a href="#ab9e7add76d59381e60fed8122dd30b64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#ab6e9e8e04da0e8022d31b08b77232fb7">lockdownd_activate</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, plist_t activation_record)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activates the device. <a href="#ab6e9e8e04da0e8022d31b08b77232fb7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#acd0ea3ab003e4e5d557ecf6e2e2b15e3">lockdownd_deactivate</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deactivates the device, returning it to the locked “Activate with iTunes” screen. <a href="#acd0ea3ab003e4e5d557ecf6e2e2b15e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a057125582e5569d43424ceeb9af0657a">lockdownd_enter_recovery</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells the device to immediately enter recovery mode. <a href="#a057125582e5569d43424ceeb9af0657a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a99d24f326f8e3118919065316a7e3b84">lockdownd_goodbye</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends the Goodbye request to lockdownd signaling the end of communication. <a href="#a99d24f326f8e3118919065316a7e3b84"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a6609ebc075b315f23108a7cd28b006de">lockdownd_client_set_label</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, const char *label)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the label to send for requests to lockdownd. <a href="#a6609ebc075b315f23108a7cd28b006de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#aea25a5a1145abac5f3a41889465fc0c7">lockdownd_get_device_uuid</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> control, char **uuid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the unique id of the device from lockdownd. <a href="#aea25a5a1145abac5f3a41889465fc0c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a981044554c3acb9e9ddc0b1c068a959d">lockdownd_get_device_name</a> (<a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> client, char **device_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the name of the device from lockdownd set by the user. <a href="#a981044554c3acb9e9ddc0b1c068a959d"></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="aba4fb7298b270067139e19b66cc35650"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_SUCCESS" ref="aba4fb7298b270067139e19b66cc35650" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_SUCCESS</b>   0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9fe97d39dea87ab6fbfc54e396dd26af"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_INVALID_ARG" ref="a9fe97d39dea87ab6fbfc54e396dd26af" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_INVALID_ARG</b>   -1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46321588a6d25a783e97a0c4dc1f715a"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_INVALID_CONF" ref="a46321588a6d25a783e97a0c4dc1f715a" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_INVALID_CONF</b>   -2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1cbbe194651ba7cf9012a40dce04eea8"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_PLIST_ERROR" ref="a1cbbe194651ba7cf9012a40dce04eea8" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_PLIST_ERROR</b>   -3</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad794582eb79197f574e26cc3e7de55eb"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_PAIRING_FAILED" ref="ad794582eb79197f574e26cc3e7de55eb" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_PAIRING_FAILED</b>   -4</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d12e933c614eb2d0a738b0f29c804b6"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_SSL_ERROR" ref="a7d12e933c614eb2d0a738b0f29c804b6" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_SSL_ERROR</b>   -5</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ba3a0ebd38f5912a8666153ba2f229d"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_DICT_ERROR" ref="a0ba3a0ebd38f5912a8666153ba2f229d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_DICT_ERROR</b>   -6</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5c3390f9de50ab4d5c7f32fae822d01"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_START_SERVICE_FAILED" ref="ab5c3390f9de50ab4d5c7f32fae822d01" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_START_SERVICE_FAILED</b>   -7</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4c6ae80778239986d617fef6c1459e3"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_NOT_ENOUGH_DATA" ref="ab4c6ae80778239986d617fef6c1459e3" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_NOT_ENOUGH_DATA</b>   -8</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a775a9984d8a55dffe782082b0891a354"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_SET_VALUE_PROHIBITED" ref="a775a9984d8a55dffe782082b0891a354" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_SET_VALUE_PROHIBITED</b>   -9</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f694c30b7b537b87e53dacaebf48ffd"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_GET_VALUE_PROHIBITED" ref="a3f694c30b7b537b87e53dacaebf48ffd" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_GET_VALUE_PROHIBITED</b>   -10</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7fc9b884e609399143c661c992e1455d"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_REMOVE_VALUE_PROHIBITED" ref="a7fc9b884e609399143c661c992e1455d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_REMOVE_VALUE_PROHIBITED</b>   -11</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cbd4dceff20c807aa1d62f1e522138c"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_MUX_ERROR" ref="a9cbd4dceff20c807aa1d62f1e522138c" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_MUX_ERROR</b>   -12</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a626b55ed7debe38f6202046c076f4eb8"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_ACTIVATION_FAILED" ref="a626b55ed7debe38f6202046c076f4eb8" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_ACTIVATION_FAILED</b>   -13</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0346f32b2d61363098f934d7f2439693"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_PASSWORD_PROTECTED" ref="a0346f32b2d61363098f934d7f2439693" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_PASSWORD_PROTECTED</b>   -14</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a427642e077a717a710ee66340ceeaa28"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_NO_RUNNING_SESSION" ref="a427642e077a717a710ee66340ceeaa28" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_NO_RUNNING_SESSION</b>   -15</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affc37f9b0c0ea041eb20aca2c2500a81"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_INVALID_HOST_ID" ref="affc37f9b0c0ea041eb20aca2c2500a81" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_INVALID_HOST_ID</b>   -16</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a1b26d3c203eeb5641977b85c65ff77"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_INVALID_SERVICE" ref="a2a1b26d3c203eeb5641977b85c65ff77" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_INVALID_SERVICE</b>   -17</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a259a520052ef3cfcc12181001358caaf"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_INVALID_ACTIVATION_RECORD" ref="a259a520052ef3cfcc12181001358caaf" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_INVALID_ACTIVATION_RECORD</b>   -18</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e1b0f74aee714e33a993d45d8d5a622"></a><!-- doxytag: member="include/libimobiledevice/lockdown.h::LOCKDOWN_E_UNKNOWN_ERROR" ref="a4e1b0f74aee714e33a993d45d8d5a622" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>LOCKDOWN_E_UNKNOWN_ERROR</b>   -256</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Implementation to communicate with the lockdown device daemon. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a8254fd517d2303ad1208eb00d622e0f3"></a><!-- doxytag: member="lockdown.h::lockdownd_client_t" ref="a8254fd517d2303ad1208eb00d622e0f3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structlockdownd__client__private.html">lockdownd_client_private</a>* <a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The client handle. </p>
</div>
</div>
<a class="anchor" id="a2c5d6e126bd17d2a5c07a5829cd0da50"></a><!-- doxytag: member="lockdown.h::lockdownd_error_t" ref="a2c5d6e126bd17d2a5c07a5829cd0da50" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int16_t <a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_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="ab6e9e8e04da0e8022d31b08b77232fb7"></a><!-- doxytag: member="lockdown.h::lockdownd_activate" ref="ab6e9e8e04da0e8022d31b08b77232fb7" args="(lockdownd_client_t client, plist_t activation_record)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_activate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>activation_record</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Activates the device. </p>
<p>Only works within an open session. The ActivationRecord plist dictionary must be obtained using the activation protocol requesting from Apple's https webservice.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a href="http://iphone-docs.org/doku.php?id=docs:protocols:activation">http://iphone-docs.org/doku.php?id=docs:protocols:activation</a></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client </td></tr>
<tr><td class="paramname">activation_record</td><td>The activation record plist dictionary</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client or activation_record is NULL, LOCKDOWN_E_NO_RUNNING_SESSION if no session is open, LOCKDOWN_E_PLIST_ERROR if the received plist is broken, LOCKDOWN_E_ACTIVATION_FAILED if the activation failed, LOCKDOWN_E_INVALID_ACTIVATION_RECORD if the device reports that the activation_record is invalid </dd></dl>
</div>
</div>
<a class="anchor" id="aa886513215f9cc696ab47696e5498904"></a><!-- doxytag: member="lockdown.h::lockdownd_client_free" ref="aa886513215f9cc696ab47696e5498904" args="(lockdownd_client_t client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_client_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the lockdownd client session if one is running and frees up the lockdownd_client struct. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="aa2ed91c7a083b6c4322840cdd9e17c7a"></a><!-- doxytag: member="lockdown.h::lockdownd_client_new" ref="aa2ed91c7a083b6c4322840cdd9e17c7a" args="(idevice_t device, lockdownd_client_t *client, const char *label)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_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"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>label</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new lockdownd client for the device. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This function does not pair with the device or start a session. This has to be done manually by the caller after the client is created. The device disconnects automatically if the lockdown connection idles for more than 10 seconds. Make sure to call <a class="el" href="include_2libimobiledevice_2lockdown_8h.html#aa886513215f9cc696ab47696e5498904" title="Closes the lockdownd client session if one is running and frees up the lockdownd_client struct...">lockdownd_client_free()</a> as soon as the connection is no longer needed.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>The device to create a lockdownd client for </td></tr>
<tr><td class="paramname">client</td><td>The pointer to the location of the new lockdownd_client </td></tr>
<tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a5af6829d41749688b92b8436eefd2853"></a><!-- doxytag: member="lockdown.h::lockdownd_client_new_with_handshake" ref="a5af6829d41749688b92b8436eefd2853" args="(idevice_t device, lockdownd_client_t *client, const char *label)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_client_new_with_handshake </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"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>label</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new lockdownd client for the device and starts initial handshake. </p>
<p>The handshake consists out of query_type, validate_pair, pair and start_session calls. It uses the internal pairing record management.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The device disconnects automatically if the lockdown connection idles for more than 10 seconds. Make sure to call <a class="el" href="include_2libimobiledevice_2lockdown_8h.html#aa886513215f9cc696ab47696e5498904" title="Closes the lockdownd client session if one is running and frees up the lockdownd_client struct...">lockdownd_client_free()</a> as soon as the connection is no longer needed.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>The device to create a lockdownd client for </td></tr>
<tr><td class="paramname">client</td><td>The pointer to the location of the new lockdownd_client </td></tr>
<tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, LOCKDOWN_E_INVALID_CONF if configuration data is wrong </dd></dl>
</div>
</div>
<a class="anchor" id="a6609ebc075b315f23108a7cd28b006de"></a><!-- doxytag: member="lockdown.h::lockdownd_client_set_label" ref="a6609ebc075b315f23108a7cd28b006de" args="(lockdownd_client_t client, const char *label)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lockdownd_client_set_label </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>label</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the label to send for requests to lockdownd. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client </td></tr>
<tr><td class="paramname">label</td><td>The label to set or NULL to disable sending a label </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acd0ea3ab003e4e5d557ecf6e2e2b15e3"></a><!-- doxytag: member="lockdown.h::lockdownd_deactivate" ref="acd0ea3ab003e4e5d557ecf6e2e2b15e3" args="(lockdownd_client_t client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_deactivate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deactivates the device, returning it to the locked “Activate with iTunes” screen. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, LOCKDOWN_E_NO_RUNNING_SESSION if no session is open, LOCKDOWN_E_PLIST_ERROR if the received plist is broken </dd></dl>
</div>
</div>
<a class="anchor" id="a057125582e5569d43424ceeb9af0657a"></a><!-- doxytag: member="lockdown.h::lockdownd_enter_recovery" ref="a057125582e5569d43424ceeb9af0657a" args="(lockdownd_client_t client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_enter_recovery </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tells the device to immediately enter recovery mode. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a981044554c3acb9e9ddc0b1c068a959d"></a><!-- doxytag: member="lockdown.h::lockdownd_get_device_name" ref="a981044554c3acb9e9ddc0b1c068a959d" args="(lockdownd_client_t client, char **device_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_get_device_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>device_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the name of the device from lockdownd set by the user. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>An initialized lockdownd client. </td></tr>
<tr><td class="paramname">device_name</td><td>Holds the name of the device. The caller is responsible for freeing the memory.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success </dd></dl>
</div>
</div>
<a class="anchor" id="aea25a5a1145abac5f3a41889465fc0c7"></a><!-- doxytag: member="lockdown.h::lockdownd_get_device_uuid" ref="aea25a5a1145abac5f3a41889465fc0c7" args="(lockdownd_client_t control, char **uuid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_get_device_uuid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>uuid</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the unique id of the device from lockdownd. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>An initialized lockdownd client. </td></tr>
<tr><td class="paramname">uuid</td><td>Holds the unique id of the device. The caller is responsible for freeing the memory.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success </dd></dl>
</div>
</div>
<a class="anchor" id="a204c585addfca987e09f8fda24a04b28"></a><!-- doxytag: member="lockdown.h::lockdownd_get_value" ref="a204c585addfca987e09f8fda24a04b28" args="(lockdownd_client_t client, const char *domain, const char *key, plist_t *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_get_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">plist_t * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves a preferences plist using an optional domain and/or key name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>An initialized lockdownd client. </td></tr>
<tr><td class="paramname">domain</td><td>The domain to query on or NULL for global domain </td></tr>
<tr><td class="paramname">key</td><td>The key name to request or NULL to query for all keys </td></tr>
<tr><td class="paramname">value</td><td>A plist node representing the result value node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a99d24f326f8e3118919065316a7e3b84"></a><!-- doxytag: member="lockdown.h::lockdownd_goodbye" ref="a99d24f326f8e3118919065316a7e3b84" args="(lockdownd_client_t client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_goodbye </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends the Goodbye request to lockdownd signaling the end of communication. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, LOCKDOWN_E_PLIST_ERROR if the device did not acknowledge the request </dd></dl>
</div>
</div>
<a class="anchor" id="a8df943348a5b657b613b931231681571"></a><!-- doxytag: member="lockdown.h::lockdownd_pair" ref="a8df943348a5b657b613b931231681571" args="(lockdownd_client_t client, lockdownd_pair_record_t pair_record)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_pair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">lockdownd_pair_record_t </td>
<td class="paramname"><em>pair_record</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pairs the device using the supplied pair record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client to pair with. </td></tr>
<tr><td class="paramname">pair_record</td><td>The pair record to use for pairing. If NULL is passed, then the pair records from the current machine are used. New records will be generated automatically when pairing is done for the first time.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, LOCKDOWN_E_PLIST_ERROR if the pair_record certificates are wrong, LOCKDOWN_E_PAIRING_FAILED if the pairing failed, LOCKDOWN_E_PASSWORD_PROTECTED if the device is password protected, LOCKDOWN_E_INVALID_HOST_ID if the device does not know the caller's host id </dd></dl>
</div>
</div>
<a class="anchor" id="a9e94b542d55e9b78dfe8a8dbbab88ef5"></a><!-- doxytag: member="lockdown.h::lockdownd_query_type" ref="a9e94b542d55e9b78dfe8a8dbbab88ef5" args="(lockdownd_client_t client, char **type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_query_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query the type of the service daemon. </p>
<p>Depending on whether the device is queried in normal mode or restore mode, different types will be returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdownd client </td></tr>
<tr><td class="paramname">type</td><td>The type returned by the service daemon. Pass NULL to ignore.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a74e4f3ea70c691e5f12f964ea1e9b42b"></a><!-- doxytag: member="lockdown.h::lockdownd_receive" ref="a74e4f3ea70c691e5f12f964ea1e9b42b" args="(lockdownd_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_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_receive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>Receives a plist from lockdownd. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdownd client </td></tr>
<tr><td class="paramname">plist</td><td>The plist to store the received data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client or plist is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a1d1e537aec30bfb4c3e0096014deeb12"></a><!-- doxytag: member="lockdown.h::lockdownd_remove_value" ref="a1d1e537aec30bfb4c3e0096014deeb12" args="(lockdownd_client_t client, const char *domain, const char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_remove_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes a preference node by domain and/or key name. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>: Use with caution as this could remove vital information on the device</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>An initialized lockdownd client. </td></tr>
<tr><td class="paramname">domain</td><td>The domain to query on or NULL for global domain </td></tr>
<tr><td class="paramname">key</td><td>The key name to remove or NULL remove all keys for the current domain</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a1c1b4c2e8e01efc67ff4319be97d5668"></a><!-- doxytag: member="lockdown.h::lockdownd_send" ref="a1c1b4c2e8e01efc67ff4319be97d5668" args="(lockdownd_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_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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 a plist to lockdownd. </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 lockdownd client </td></tr>
<tr><td class="paramname">plist</td><td>The plist to send</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client or plist is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a3aeb41a3f2243437fc87d99f5ea4aadb"></a><!-- doxytag: member="lockdown.h::lockdownd_set_value" ref="a3aeb41a3f2243437fc87d99f5ea4aadb" args="(lockdownd_client_t client, const char *domain, const char *key, plist_t value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_set_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">plist_t </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a preferences value using a plist and optional by domain and/or key name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>an initialized lockdownd client. </td></tr>
<tr><td class="paramname">domain</td><td>the domain to query on or NULL for global domain </td></tr>
<tr><td class="paramname">key</td><td>the key name to set the value or NULL to set a value dict plist </td></tr>
<tr><td class="paramname">value</td><td>a plist node of any node type representing the value to set</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client or value is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="a51f93594093dc6e56d978dda0e1f653b"></a><!-- doxytag: member="lockdown.h::lockdownd_start_service" ref="a51f93594093dc6e56d978dda0e1f653b" args="(lockdownd_client_t client, const char *service, uint16_t *port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_start_service </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>service</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Requests to start a service and retrieve it's port on success. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdownd client </td></tr>
<tr><td class="paramname">service</td><td>The name of the service to start </td></tr>
<tr><td class="paramname">port</td><td>The port number the service was started on</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG if a parameter is NULL, LOCKDOWN_E_INVALID_SERVICE if the requested service is not known by the device, LOCKDOWN_E_START_SERVICE_FAILED if the service could not because started by the device </dd></dl>
</div>
</div>
<a class="anchor" id="a21d7159ab85f8fca0e94751e8bb8f401"></a><!-- doxytag: member="lockdown.h::lockdownd_start_session" ref="a21d7159ab85f8fca0e94751e8bb8f401" args="(lockdownd_client_t client, const char *host_id, char **session_id, int *ssl_enabled)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_start_session </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>host_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>session_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>ssl_enabled</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opens a session with lockdownd and switches to SSL mode if device wants it. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdownd client </td></tr>
<tr><td class="paramname">host_id</td><td>The HostID of the computer </td></tr>
<tr><td class="paramname">session_id</td><td>The new session_id of the created session </td></tr>
<tr><td class="paramname">ssl_enabled</td><td>Whether SSL communication is used in the session</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when a client or host_id is NULL, LOCKDOWN_E_PLIST_ERROR if the response plist had errors, LOCKDOWN_E_INVALID_HOST_ID if the device does not know the supplied HostID, LOCKDOWN_E_SSL_ERROR if enabling SSL communication failed </dd></dl>
</div>
</div>
<a class="anchor" id="ad6f68455954be19911d495345390f6fb"></a><!-- doxytag: member="lockdown.h::lockdownd_stop_session" ref="ad6f68455954be19911d495345390f6fb" args="(lockdownd_client_t client, const char *session_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_stop_session </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_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>session_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the lockdownd session by sending the StopSession request. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a21d7159ab85f8fca0e94751e8bb8f401" title="Opens a session with lockdownd and switches to SSL mode if device wants it.">lockdownd_start_session</a></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client </td></tr>
<tr><td class="paramname">session_id</td><td>The id of a running session</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL </dd></dl>
</div>
</div>
<a class="anchor" id="ab9e7add76d59381e60fed8122dd30b64"></a><!-- doxytag: member="lockdown.h::lockdownd_unpair" ref="ab9e7add76d59381e60fed8122dd30b64" args="(lockdownd_client_t client, lockdownd_pair_record_t pair_record)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_unpair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">lockdownd_pair_record_t </td>
<td class="paramname"><em>pair_record</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unpairs the device with the given HostID and removes the pairing records from the device and host if the internal pairing record management is used. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client to pair with. </td></tr>
<tr><td class="paramname">pair_record</td><td>The pair record to use for unpair. If NULL is passed, then the pair records from the current machine are used.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, LOCKDOWN_E_PLIST_ERROR if the pair_record certificates are wrong, LOCKDOWN_E_PAIRING_FAILED if the pairing failed, LOCKDOWN_E_PASSWORD_PROTECTED if the device is password protected, LOCKDOWN_E_INVALID_HOST_ID if the device does not know the caller's host id </dd></dl>
</div>
</div>
<a class="anchor" id="af36157f83cb262680bbc8903fcf1ba8a"></a><!-- doxytag: member="lockdown.h::lockdownd_validate_pair" ref="af36157f83cb262680bbc8903fcf1ba8a" args="(lockdownd_client_t client, lockdownd_pair_record_t pair_record)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a2c5d6e126bd17d2a5c07a5829cd0da50">lockdownd_error_t</a> lockdownd_validate_pair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlockdownd__client__private.html">lockdownd_client_t</a> </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">lockdownd_pair_record_t </td>
<td class="paramname"><em>pair_record</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Validates if the device is paired with the given HostID. </p>
<p>If succeeded them specified host will become trusted host of the device indicated by the lockdownd preference named TrustedHostAttached. Otherwise the host must because paired using <a class="el" href="include_2libimobiledevice_2lockdown_8h.html#a8df943348a5b657b613b931231681571" title="Pairs the device using the supplied pair record.">lockdownd_pair()</a> first.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>The lockdown client to pair with. </td></tr>
<tr><td class="paramname">pair_record</td><td>The pair record to validate pairing with. If NULL is passed, then the pair record is read from the internal pairing record management.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, LOCKDOWN_E_PLIST_ERROR if the pair_record certificates are wrong, LOCKDOWN_E_PAIRING_FAILED if the pairing failed, LOCKDOWN_E_PASSWORD_PROTECTED if the device is password protected, LOCKDOWN_E_INVALID_HOST_ID if the device does not know the caller's host id </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>
