Interface IHouseArrestApi

Namespace: iMobileDevice.HouseArrest

Assembly: iMobileDevice-net.dll

Syntax

public interface IHouseArrestApi

Properties

| Improve this Doc View Source

Parent

Gets or sets the which owns this iMobileDevice.HouseArrest.

Declaration

ILibiMobileDevice Parent { get; }

Property Value

Type	Description
ILibiMobileDevice

Methods

| Improve this Doc View Source

afc_client_new_from_house_arrest_client(HouseArrestClientHandle, out AfcClientHandle)

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().

Declaration

AfcError afc_client_new_from_house_arrest_client(HouseArrestClientHandle client, out AfcClientHandle afcClient)

Parameters

Type	Name	Description
HouseArrestClientHandle	client	The house_arrest client to use.
AfcClientHandle	afcClient

Returns

Type	Description
AfcError	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_with_service_client().

Remarks

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.

| Improve this Doc View Source

house_arrest_client_free(IntPtr)

Disconnects an house_arrest client from the device and frees up the house_arrest client data.

Declaration

HouseArrestError house_arrest_client_free(IntPtr client)

Parameters

Type	Name	Description
System.IntPtr	client	The house_arrest client to disconnect and free.

Returns

Type	Description
HouseArrestError	HOUSE_ARREST_E_SUCCESS on success, HOUSE_ARREST_E_INVALID_ARG when client is NULL, or an HOUSE_ARREST_E_* error code otherwise.

Remarks

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.

| Improve this Doc View Source

house_arrest_client_new(iDeviceHandle, LockdownServiceDescriptorHandle, out HouseArrestClientHandle)

Connects to the house_arrest service on the specified device.

Declaration

HouseArrestError house_arrest_client_new(iDeviceHandle device, LockdownServiceDescriptorHandle service, out HouseArrestClientHandle client)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
LockdownServiceDescriptorHandle	service	The service descriptor returned by lockdownd_start_service.
HouseArrestClientHandle	client	Pointer that will point to a newly allocated housearrest_client_t upon successful return.

Returns

Type	Description
HouseArrestError	HOUSE_ARREST_E_SUCCESS on success, HOUSE_ARREST_E_INVALID_ARG when client is NULL, or an HOUSE_ARREST_E_* error code otherwise.

| Improve this Doc View Source

house_arrest_client_start_service(iDeviceHandle, out HouseArrestClientHandle, String)

Starts a new house_arrest service on the specified device and connects to it.

Declaration

HouseArrestError house_arrest_client_start_service(iDeviceHandle device, out HouseArrestClientHandle client, string label)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
HouseArrestClientHandle	client	Pointer that will point to a newly allocated house_arrest_client_t upon successful return. Must be freed using house_arrest_client_free() after use.
System.String	label	The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.

Returns

Type	Description
HouseArrestError	HOUSE_ARREST_E_SUCCESS on success, or an HOUSE_ARREST_E_* error code otherwise.

| Improve this Doc View Source

house_arrest_get_result(HouseArrestClientHandle, out PlistHandle)

Retrieves the result of a previously sent house_arrest_request_* request.

Declaration

HouseArrestError house_arrest_get_result(HouseArrestClientHandle client, out PlistHandle dict)

Parameters

Type	Name	Description
HouseArrestClientHandle	client	The house_arrest client to use
PlistHandle	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

Type	Description
HouseArrestError	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.

| Improve this Doc View Source

house_arrest_send_command(HouseArrestClientHandle, String, String)

Send a command to the connected house_arrest service. Calls house_arrest_send_request() internally.

Declaration

HouseArrestError house_arrest_send_command(HouseArrestClientHandle client, string command, string appid)

Parameters

Type	Name	Description
HouseArrestClientHandle	client	The house_arrest client to use.
System.String	command	The command to send. Currently, only VendContainer and VendDocuments are known.
System.String	appid	The application identifier to pass along with the .

Returns

Type	Description
HouseArrestError	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.

Remarks

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().

| Improve this Doc View Source

house_arrest_send_request(HouseArrestClientHandle, PlistHandle)

Sends a generic request to the connected house_arrest service.

Declaration

HouseArrestError house_arrest_send_request(HouseArrestClientHandle client, PlistHandle dict)

Parameters

Type	Name	Description
HouseArrestClientHandle	client	The house_arrest client to use.
PlistHandle	dict	The request to send as a plist of type PLIST_DICT.

Returns

Type	Description
HouseArrestError	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.

Remarks

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().