summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--include/libimobiledevice/restore.h20
1 files changed, 10 insertions, 10 deletions
diff --git a/include/libimobiledevice/restore.h b/include/libimobiledevice/restore.h
index f4e8822..63f8915 100644
--- a/include/libimobiledevice/restore.h
+++ b/include/libimobiledevice/restore.h
@@ -59,7 +59,7 @@ typedef restored_client_private *restored_client_t; /**< The client handle. */
59 * @param client The pointer to the location of the new restored_client 59 * @param client The pointer to the location of the new restored_client
60 * @param label The label to use for communication. Usually the program name. 60 * @param label The label to use for communication. Usually the program name.
61 * 61 *
62 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 62 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL
63 */ 63 */
64restored_error_t restored_client_new(idevice_t device, restored_client_t *client, const char *label); 64restored_error_t restored_client_new(idevice_t device, restored_client_t *client, const char *label);
65 65
@@ -69,7 +69,7 @@ restored_error_t restored_client_new(idevice_t device, restored_client_t *client
69 * 69 *
70 * @param client The restore client 70 * @param client The restore client
71 * 71 *
72 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 72 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL
73 */ 73 */
74restored_error_t restored_client_free(restored_client_t client); 74restored_error_t restored_client_free(restored_client_t client);
75 75
@@ -82,7 +82,7 @@ restored_error_t restored_client_free(restored_client_t client);
82 * @param type The type returned by the service daemon. Pass NULL to ignore. 82 * @param type The type returned by the service daemon. Pass NULL to ignore.
83 * @param version The restore protocol version. Pass NULL to ignore. 83 * @param version The restore protocol version. Pass NULL to ignore.
84 * 84 *
85 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL 85 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL
86 */ 86 */
87restored_error_t restored_query_type(restored_client_t client, char **type, uint64_t *version); 87restored_error_t restored_query_type(restored_client_t client, char **type, uint64_t *version);
88 88
@@ -93,7 +93,7 @@ restored_error_t restored_query_type(restored_client_t client, char **type, uint
93 * @param key The key name to request 93 * @param key The key name to request
94 * @param value A plist node representing the result value node 94 * @param value A plist node representing the result value node
95 * 95 *
96 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found 96 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found
97 */ 97 */
98restored_error_t restored_query_value(restored_client_t client, const char *key, plist_t *value); 98restored_error_t restored_query_value(restored_client_t client, const char *key, plist_t *value);
99 99
@@ -104,7 +104,7 @@ restored_error_t restored_query_value(restored_client_t client, const char *key,
104 * @param key The key name to request or NULL to query for all keys 104 * @param key The key name to request or NULL to query for all keys
105 * @param value A plist node representing the result value node 105 * @param value A plist node representing the result value node
106 * 106 *
107 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found 107 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if value for key can't be found
108 */ 108 */
109restored_error_t restored_get_value(restored_client_t client, const char *key, plist_t *value) ; 109restored_error_t restored_get_value(restored_client_t client, const char *key, plist_t *value) ;
110 110
@@ -117,7 +117,7 @@ restored_error_t restored_get_value(restored_client_t client, const char *key, p
117 * @param client The restored client 117 * @param client The restored client
118 * @param plist The plist to send 118 * @param plist The plist to send
119 * 119 *
120 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client or 120 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client or
121 * plist is NULL 121 * plist is NULL
122 */ 122 */
123restored_error_t restored_send(restored_client_t client, plist_t plist); 123restored_error_t restored_send(restored_client_t client, plist_t plist);
@@ -128,7 +128,7 @@ restored_error_t restored_send(restored_client_t client, plist_t plist);
128 * @param client The restored client 128 * @param client The restored client
129 * @param plist The plist to store the received data 129 * @param plist The plist to store the received data
130 * 130 *
131 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client or 131 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client or
132 * plist is NULL 132 * plist is NULL
133 */ 133 */
134restored_error_t restored_receive(restored_client_t client, plist_t *plist); 134restored_error_t restored_receive(restored_client_t client, plist_t *plist);
@@ -138,7 +138,7 @@ restored_error_t restored_receive(restored_client_t client, plist_t *plist);
138 * 138 *
139 * @param client The restore client 139 * @param client The restore client
140 * 140 *
141 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, 141 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG when client is NULL,
142 * RESTORE_E_PLIST_ERROR if the device did not acknowledge the request 142 * RESTORE_E_PLIST_ERROR if the device did not acknowledge the request
143 */ 143 */
144restored_error_t restored_goodbye(restored_client_t client); 144restored_error_t restored_goodbye(restored_client_t client);
@@ -151,7 +151,7 @@ restored_error_t restored_goodbye(restored_client_t client);
151 * @param options PLIST_DICT with options for the restore process or NULL 151 * @param options PLIST_DICT with options for the restore process or NULL
152 * @param version the restore protocol version, see restored_query_type() 152 * @param version the restore protocol version, see restored_query_type()
153 * 153 *
154 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG if a parameter 154 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG if a parameter
155 * is NULL, RESTORE_E_START_RESTORE_FAILED if the request fails 155 * is NULL, RESTORE_E_START_RESTORE_FAILED if the request fails
156 */ 156 */
157restored_error_t restored_start_restore(restored_client_t client, plist_t options, uint64_t version); 157restored_error_t restored_start_restore(restored_client_t client, plist_t options, uint64_t version);
@@ -161,7 +161,7 @@ restored_error_t restored_start_restore(restored_client_t client, plist_t option
161 * 161 *
162 * @param client The restored client 162 * @param client The restored client
163 * 163 *
164 * @return RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG if a parameter 164 * @return RESTORE_E_SUCCESS on success, RESTORE_E_INVALID_ARG if a parameter
165 * is NULL 165 * is NULL
166 */ 166 */
167restored_error_t restored_reboot(restored_client_t client); 167restored_error_t restored_reboot(restored_client_t client);