libimobiledevice/house_arrest.h File Reference
Access AppStore application folders and their contents.
More...
Detailed Description
Access AppStore application folders and their contents.
Typedef Documentation
Represents an error code.
Function Documentation
Creates an AFC client using the given house_arrest client's connection allowing file access to a specific application directory requested by functions like house_arrest_request_vendor_documents().
- Parameters:
-
| client | The house_arrest client to use. - Parameters:
-
| afc_client | Pointer that will be set to a newly allocated afc_client_t upon successful return. |
- Note:
- After calling this function the house_arrest client will go in an AFC mode that will only allow calling house_arrest_client_free(). Only call house_arrest_client_free() if all AFC operations have completed since it will close the connection.
- Returns:
- AFC_E_SUCCESS if the afc client was successfully created, AFC_E_INVALID_ARG if client is invalid or was already used to create an afc client, or an AFC_E_* error code returned by afc_client_new_from_connection().
|
Disconnects an house_arrest client from the device and frees up the house_arrest client data.
- Note:
- After using afc_client_new_from_house_arrest_client(), make sure you call afc_client_free() before calling this function to ensure a proper cleanup. Do not call this function if you still need to perform AFC operations since it will close the connection.
- Parameters:
-
| client | The house_arrest client to disconnect and free. |
- Returns:
- HOUSE_ARREST_E_SUCCESS on success, HOUSE_ARREST_E_INVALID_ARG when client is NULL, or an HOUSE_ARREST_E_* error code otherwise.
Connects to the house_arrest service on the specified device.
- Parameters:
-
| device | The device to connect to. - Parameters:
-
| port | Destination port (usually given by lockdownd_start_service). - Parameters:
-
| client | Pointer that will point to a newly allocated housearrest_client_t upon successful return. |
- Returns:
- HOUSE_ARREST_E_SUCCESS on success, HOUSE_ARREST_E_INVALID_ARG when client is NULL, or an HOUSE_ARREST_E_* error code otherwise.
|
|
Retrieves the result of a previously sent house_arrest_request_* request.
- Parameters:
-
| client | The house_arrest client to use - Parameters:
-
| dict | Pointer that will be set to a plist containing the result to the last performed operation. It holds a key 'Status' with the value 'Complete' on success or a key 'Error' with an error description as value. The caller is responsible for freeing the returned plist. |
- Returns:
- HOUSE_ARREST_E_SUCCESS if a result plist was retrieved, HOUSE_ARREST_E_INVALID_ARG if client is invalid, HOUSE_ARREST_E_INVALID_MODE if the client is not in the correct mode, or HOUSE_ARREST_E_CONN_FAILED if a connection error occured.
|
Send a command to the connected house_arrest service.
Calls house_arrest_send_request() internally.
- Parameters:
-
| client | The house_arrest client to use. - Parameters:
-
| command | The command to send. Currently, only VendContainer and VendDocuments are known. - Parameters:
-
| appid | The application identifier to pass along with the . |
- Note:
- If this function returns HOUSE_ARREST_E_SUCCESS it does not mean that the command was successful. To check for success or failure you need to call house_arrest_get_result().
- See also:
- house_arrest_get_result
- Returns:
- HOUSE_ARREST_E_SUCCESS if the command was successfully sent, HOUSE_ARREST_E_INVALID_ARG if client, command, or appid is invalid, HOUSE_ARREST_E_INVALID_MODE if the client is not in the correct mode, or HOUSE_ARREST_E_CONN_FAILED if a connection error occured.
|
|
Sends a generic request to the connected house_arrest service.
- Parameters:
-
| client | The house_arrest client to use. - Parameters:
-
| dict | The request to send as a plist of type PLIST_DICT. |
- Note:
- If this function returns HOUSE_ARREST_E_SUCCESS it does not mean that the request was successful. To check for success or failure you need to call house_arrest_get_result().
- See also:
- house_arrest_get_result
- Returns:
- HOUSE_ARREST_E_SUCCESS if the request was successfully sent, HOUSE_ARREST_E_INVALID_ARG if client or dict is invalid, HOUSE_ARREST_E_PLIST_ERROR if dict is not a plist of type PLIST_DICT, HOUSE_ARREST_E_INVALID_MODE if the client is not in the correct mode, or HOUSE_ARREST_E_CONN_FAILED if a connection error occured.
|