libimobiledevice/restore.h File Reference
Initiate restore process or reboot device.
More...
Detailed Description
Initiate restore process or reboot device.
Typedef Documentation
Represents an error code.
Function Documentation
Closes the restored client session if one is running and frees up the restored_client struct.
- Parameters:
-
| client | The restore client |
- Returns:
- RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL
Creates a new restored client for the device.
- Parameters:
-
| device | The device to create a restored client for - Parameters:
-
| client | The pointer to the location of the new restored_client - Parameters:
-
| label | The label to use for communication. Usually the program name. |
- Returns:
- RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL
|
|
Sets the label to send for requests to restored.
- Parameters:
-
| client | The restore client - Parameters:
-
| label | The label to set or NULL to disable sending a label |
|
Retrieves a value from information plist specified by a key.
- Parameters:
-
| client | An initialized restored client. - Parameters:
-
| key | The key name to request or NULL to query for all keys - Parameters:
-
| value | A plist node representing the result value node |
- Returns:
- 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
|
|
Sends the Goodbye request to restored signaling the end of communication.
- Parameters:
-
| client | The restore client |
- Returns:
- RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL, RESTORE_E_PLIST_ERROR if the device did not acknowledge the request
Query the type of the service daemon.
Depending on whether the device is queried in normal mode or restore mode, different types will be returned.
- Parameters:
-
| client | The restored client - Parameters:
-
| type | The type returned by the service daemon. Pass NULL to ignore. - Parameters:
-
| version | The restore protocol version. Pass NULL to ignore. |
- Returns:
- RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client is NULL
|
|
Requests device to reboot.
- Parameters:
-
| client | The restored client |
- Returns:
- RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG if a parameter is NULL
Receives a plist from restored.
- Parameters:
-
| client | The restored client - Parameters:
-
| plist | The plist to store the received data |
- Returns:
- RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client or plist is NULL
|
Sends a plist to restored.
- Note:
- This function is low-level and should only be used if you need to send a new type of message.
- Parameters:
-
| client | The restored client - Parameters:
-
- Returns:
- RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG when client or plist is NULL
|
Requests to start a restore and retrieve it's port on success.
- Parameters:
-
| client | The restored client |
- Returns:
- RESTORE_E_SUCCESS on success, NP_E_INVALID_ARG if a parameter is NULL, RESTORE_E_START_RESTORE_FAILED if the request fails