summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--include/libimobiledevice/lockdown.h34
1 files changed, 17 insertions, 17 deletions
diff --git a/include/libimobiledevice/lockdown.h b/include/libimobiledevice/lockdown.h
index b682060..ab6ae88 100644
--- a/include/libimobiledevice/lockdown.h
+++ b/include/libimobiledevice/lockdown.h
@@ -95,7 +95,7 @@ typedef struct lockdownd_service_descriptor *lockdownd_service_descriptor_t;
95 * @param client The pointer to the location of the new lockdownd_client 95 * @param client The pointer to the location of the new lockdownd_client
96 * @param label The label to use for communication. Usually the program name. 96 * @param label The label to use for communication. Usually the program name.
97 * 97 *
98 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 98 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL
99 */ 99 */
100lockdownd_error_t lockdownd_client_new(idevice_t device, lockdownd_client_t *client, const char *label); 100lockdownd_error_t lockdownd_client_new(idevice_t device, lockdownd_client_t *client, const char *label);
101 101
@@ -113,7 +113,7 @@ lockdownd_error_t lockdownd_client_new(idevice_t device, lockdownd_client_t *cli
113 * @param label The label to use for communication. Usually the program name. 113 * @param label The label to use for communication. Usually the program name.
114 * Pass NULL to disable sending the label in requests to lockdownd. 114 * Pass NULL to disable sending the label in requests to lockdownd.
115 * 115 *
116 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, 116 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL,
117 * LOCKDOWN_E_INVALID_CONF if configuration data is wrong 117 * LOCKDOWN_E_INVALID_CONF if configuration data is wrong
118 */ 118 */
119lockdownd_error_t lockdownd_client_new_with_handshake(idevice_t device, lockdownd_client_t *client, const char *label); 119lockdownd_error_t lockdownd_client_new_with_handshake(idevice_t device, lockdownd_client_t *client, const char *label);
@@ -124,7 +124,7 @@ lockdownd_error_t lockdownd_client_new_with_handshake(idevice_t device, lockdown
124 * 124 *
125 * @param client The lockdown client 125 * @param client The lockdown client
126 * 126 *
127 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 127 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL
128 */ 128 */
129lockdownd_error_t lockdownd_client_free(lockdownd_client_t client); 129lockdownd_error_t lockdownd_client_free(lockdownd_client_t client);
130 130
@@ -136,7 +136,7 @@ lockdownd_error_t lockdownd_client_free(lockdownd_client_t client);
136 * @param client The lockdownd client 136 * @param client The lockdownd client
137 * @param type The type returned by the service daemon. Pass NULL to ignore. 137 * @param type The type returned by the service daemon. Pass NULL to ignore.
138 * 138 *
139 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 139 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL
140 */ 140 */
141lockdownd_error_t lockdownd_query_type(lockdownd_client_t client, char **type); 141lockdownd_error_t lockdownd_query_type(lockdownd_client_t client, char **type);
142 142
@@ -148,7 +148,7 @@ lockdownd_error_t lockdownd_query_type(lockdownd_client_t client, char **type);
148 * @param key The key name to request or NULL to query for all keys 148 * @param key The key name to request or NULL to query for all keys
149 * @param value A plist node representing the result value node 149 * @param value A plist node representing the result value node
150 * 150 *
151 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 151 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL
152 */ 152 */
153lockdownd_error_t lockdownd_get_value(lockdownd_client_t client, const char *domain, const char *key, plist_t *value); 153lockdownd_error_t lockdownd_get_value(lockdownd_client_t client, const char *domain, const char *key, plist_t *value);
154 154
@@ -160,7 +160,7 @@ lockdownd_error_t lockdownd_get_value(lockdownd_client_t client, const char *dom
160 * @param key the key name to set the value or NULL to set a value dict plist 160 * @param key the key name to set the value or NULL to set a value dict plist
161 * @param value a plist node of any node type representing the value to set 161 * @param value a plist node of any node type representing the value to set
162 * 162 *
163 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client or 163 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client or
164 * value is NULL 164 * value is NULL
165 */ 165 */
166lockdownd_error_t lockdownd_set_value(lockdownd_client_t client, const char *domain, const char *key, plist_t value); 166lockdownd_error_t lockdownd_set_value(lockdownd_client_t client, const char *domain, const char *key, plist_t value);
@@ -174,7 +174,7 @@ lockdownd_error_t lockdownd_set_value(lockdownd_client_t client, const char *dom
174 * @param domain The domain to query on or NULL for global domain 174 * @param domain The domain to query on or NULL for global domain
175 * @param key The key name to remove or NULL remove all keys for the current domain 175 * @param key The key name to remove or NULL remove all keys for the current domain
176 * 176 *
177 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 177 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL
178 */ 178 */
179lockdownd_error_t lockdownd_remove_value(lockdownd_client_t client, const char *domain, const char *key); 179lockdownd_error_t lockdownd_remove_value(lockdownd_client_t client, const char *domain, const char *key);
180 180
@@ -185,7 +185,7 @@ lockdownd_error_t lockdownd_remove_value(lockdownd_client_t client, const char *
185 * @param identifier The identifier of the service to start 185 * @param identifier The identifier of the service to start
186 * @param descriptor The service descriptor on success or NULL on failure 186 * @param descriptor The service descriptor on success or NULL on failure
187 187
188 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG if a parameter 188 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG if a parameter
189 * is NULL, LOCKDOWN_E_INVALID_SERVICE if the requested service is not known 189 * is NULL, LOCKDOWN_E_INVALID_SERVICE if the requested service is not known
190 * by the device, LOCKDOWN_E_START_SERVICE_FAILED if the service could not be 190 * by the device, LOCKDOWN_E_START_SERVICE_FAILED if the service could not be
191 * started by the device 191 * started by the device
@@ -215,7 +215,7 @@ lockdownd_error_t lockdownd_start_session(lockdownd_client_t client, const char
215 * @param client The lockdown client 215 * @param client The lockdown client
216 * @param session_id The id of a running session 216 * @param session_id The id of a running session
217 * 217 *
218 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 218 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL
219 */ 219 */
220lockdownd_error_t lockdownd_stop_session(lockdownd_client_t client, const char *session_id); 220lockdownd_error_t lockdownd_stop_session(lockdownd_client_t client, const char *session_id);
221 221
@@ -228,7 +228,7 @@ lockdownd_error_t lockdownd_stop_session(lockdownd_client_t client, const char *
228 * @param client The lockdownd client 228 * @param client The lockdownd client
229 * @param plist The plist to send 229 * @param plist The plist to send
230 * 230 *
231 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client or 231 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client or
232 * plist is NULL 232 * plist is NULL
233 */ 233 */
234lockdownd_error_t lockdownd_send(lockdownd_client_t client, plist_t plist); 234lockdownd_error_t lockdownd_send(lockdownd_client_t client, plist_t plist);
@@ -239,7 +239,7 @@ lockdownd_error_t lockdownd_send(lockdownd_client_t client, plist_t plist);
239 * @param client The lockdownd client 239 * @param client The lockdownd client
240 * @param plist The plist to store the received data 240 * @param plist The plist to store the received data
241 * 241 *
242 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client or 242 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client or
243 * plist is NULL 243 * plist is NULL
244 */ 244 */
245lockdownd_error_t lockdownd_receive(lockdownd_client_t client, plist_t *plist); 245lockdownd_error_t lockdownd_receive(lockdownd_client_t client, plist_t *plist);
@@ -252,7 +252,7 @@ lockdownd_error_t lockdownd_receive(lockdownd_client_t client, plist_t *plist);
252 * the pair records from the current machine are used. New records will be 252 * the pair records from the current machine are used. New records will be
253 * generated automatically when pairing is done for the first time. 253 * generated automatically when pairing is done for the first time.
254 * 254 *
255 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, 255 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL,
256 * LOCKDOWN_E_PLIST_ERROR if the pair_record certificates are wrong, 256 * LOCKDOWN_E_PLIST_ERROR if the pair_record certificates are wrong,
257 * LOCKDOWN_E_PAIRING_FAILED if the pairing failed, 257 * LOCKDOWN_E_PAIRING_FAILED if the pairing failed,
258 * LOCKDOWN_E_PASSWORD_PROTECTED if the device is password protected, 258 * LOCKDOWN_E_PASSWORD_PROTECTED if the device is password protected,
@@ -271,7 +271,7 @@ lockdownd_error_t lockdownd_pair(lockdownd_client_t client, lockdownd_pair_recor
271 * passed, then the pair record is read from the internal pairing record 271 * passed, then the pair record is read from the internal pairing record
272 * management. 272 * management.
273 * 273 *
274 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, 274 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL,
275 * LOCKDOWN_E_PLIST_ERROR if the pair_record certificates are wrong, 275 * LOCKDOWN_E_PLIST_ERROR if the pair_record certificates are wrong,
276 * LOCKDOWN_E_PAIRING_FAILED if the pairing failed, 276 * LOCKDOWN_E_PAIRING_FAILED if the pairing failed,
277 * LOCKDOWN_E_PASSWORD_PROTECTED if the device is password protected, 277 * LOCKDOWN_E_PASSWORD_PROTECTED if the device is password protected,
@@ -287,7 +287,7 @@ lockdownd_error_t lockdownd_validate_pair(lockdownd_client_t client, lockdownd_p
287 * @param pair_record The pair record to use for unpair. If NULL is passed, then 287 * @param pair_record The pair record to use for unpair. If NULL is passed, then
288 * the pair records from the current machine are used. 288 * the pair records from the current machine are used.
289 * 289 *
290 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, 290 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL,
291 * LOCKDOWN_E_PLIST_ERROR if the pair_record certificates are wrong, 291 * LOCKDOWN_E_PLIST_ERROR if the pair_record certificates are wrong,
292 * LOCKDOWN_E_PAIRING_FAILED if the pairing failed, 292 * LOCKDOWN_E_PAIRING_FAILED if the pairing failed,
293 * LOCKDOWN_E_PASSWORD_PROTECTED if the device is password protected, 293 * LOCKDOWN_E_PASSWORD_PROTECTED if the device is password protected,
@@ -305,7 +305,7 @@ lockdownd_error_t lockdownd_unpair(lockdownd_client_t client, lockdownd_pair_rec
305 * @param client The lockdown client 305 * @param client The lockdown client
306 * @param activation_record The activation record plist dictionary 306 * @param activation_record The activation record plist dictionary
307 * 307 *
308 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client or 308 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client or
309 * activation_record is NULL, LOCKDOWN_E_NO_RUNNING_SESSION if no session is 309 * activation_record is NULL, LOCKDOWN_E_NO_RUNNING_SESSION if no session is
310 * open, LOCKDOWN_E_PLIST_ERROR if the received plist is broken, 310 * open, LOCKDOWN_E_PLIST_ERROR if the received plist is broken,
311 * LOCKDOWN_E_ACTIVATION_FAILED if the activation failed, 311 * LOCKDOWN_E_ACTIVATION_FAILED if the activation failed,
@@ -320,7 +320,7 @@ lockdownd_error_t lockdownd_activate(lockdownd_client_t client, plist_t activati
320 * 320 *
321 * @param client The lockdown client 321 * @param client The lockdown client
322 * 322 *
323 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, 323 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL,
324 * LOCKDOWN_E_NO_RUNNING_SESSION if no session is open, 324 * LOCKDOWN_E_NO_RUNNING_SESSION if no session is open,
325 * LOCKDOWN_E_PLIST_ERROR if the received plist is broken 325 * LOCKDOWN_E_PLIST_ERROR if the received plist is broken
326 */ 326 */
@@ -331,7 +331,7 @@ lockdownd_error_t lockdownd_deactivate(lockdownd_client_t client);
331 * 331 *
332 * @param client The lockdown client 332 * @param client The lockdown client
333 * 333 *
334 * @return LOCKDOWN_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 334 * @return LOCKDOWN_E_SUCCESS on success, LOCKDOWN_E_INVALID_ARG when client is NULL
335 */ 335 */
336lockdownd_error_t lockdownd_enter_recovery(lockdownd_client_t client); 336lockdownd_error_t lockdownd_enter_recovery(lockdownd_client_t client);
337 337