Interface IMobileImageMounterApi

Namespace: iMobileDevice.MobileImageMounter

Assembly: iMobileDevice-net.dll

Syntax

public interface IMobileImageMounterApi

Properties

| Improve this Doc View Source

Parent

Gets or sets the which owns this iMobileDevice.MobileImageMounter.

Declaration

ILibiMobileDevice Parent { get; }

Property Value

Type	Description
ILibiMobileDevice

Methods

| Improve this Doc View Source

mobile_image_mounter_free(IntPtr)

Disconnects a mobile_image_mounter client from the device and frees up the mobile_image_mounter client data.

Declaration

MobileImageMounterError mobile_image_mounter_free(IntPtr client)

Parameters

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

Returns

Type	Description
MobileImageMounterError	MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, or MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if client is NULL.

| Improve this Doc View Source

mobile_image_mounter_hangup(MobileImageMounterClientHandle)

Hangs up the connection to the mobile_image_mounter service. This functions has to be called before freeing up a mobile_image_mounter instance. If not, errors appear in the device's syslog.

Declaration

MobileImageMounterError mobile_image_mounter_hangup(MobileImageMounterClientHandle client)

Parameters

Type	Name	Description
MobileImageMounterClientHandle	client	The client to hang up

Returns

Type	Description
MobileImageMounterError	MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if client is invalid, or another error code otherwise.

| Improve this Doc View Source

mobile_image_mounter_lookup_image(MobileImageMounterClientHandle, String, out PlistHandle)

Tells if the image of ImageType is already mounted.

Declaration

MobileImageMounterError mobile_image_mounter_lookup_image(MobileImageMounterClientHandle client, string imageType, out PlistHandle result)

Parameters

Type	Name	Description
MobileImageMounterClientHandle	client	The client use
System.String	imageType
PlistHandle	result	Pointer to a plist that will receive the result of the operation.

Returns

Type	Description
MobileImageMounterError	MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, or an error code on error

Remarks

This function may return MOBILE_IMAGE_MOUNTER_E_SUCCESS even if the operation has failed. Check the resulting plist for further information.

| Improve this Doc View Source

mobile_image_mounter_mount_image(MobileImageMounterClientHandle, String, Byte[], UInt16, String, out PlistHandle)

Mounts an image on the device.

Declaration

MobileImageMounterError mobile_image_mounter_mount_image(MobileImageMounterClientHandle client, string imagePath, byte[] signature, ushort signatureSize, string imageType, out PlistHandle result)

Parameters

Type	Name	Description
MobileImageMounterClientHandle	client	The connected mobile_image_mounter client.
System.String	imagePath
System.Byte[]	signature	Pointer to a buffer holding the images' signature
System.UInt16	signatureSize
System.String	imageType
PlistHandle	result	Pointer to a plist that will receive the result of the operation.

Returns

Type	Description
MobileImageMounterError	MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if on ore more parameters are invalid, or another error code otherwise.

Remarks

This function may return MOBILE_IMAGE_MOUNTER_E_SUCCESS even if the operation has failed. Check the resulting plist for further information. Note that there is no unmounting function. The mount persists until the device is rebooted.

| Improve this Doc View Source

mobile_image_mounter_new(iDeviceHandle, LockdownServiceDescriptorHandle, out MobileImageMounterClientHandle)

Connects to the mobile_image_mounter service on the specified device.

Declaration

MobileImageMounterError mobile_image_mounter_new(iDeviceHandle device, LockdownServiceDescriptorHandle service, out MobileImageMounterClientHandle client)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
LockdownServiceDescriptorHandle	service	The service descriptor returned by lockdownd_start_service.
MobileImageMounterClientHandle	client	Pointer that will be set to a newly allocated mobile_image_mounter_client_t upon successful return.

Returns

Type	Description
MobileImageMounterError	MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, MOBILE_IMAGE_MOUNTER_E_INVALID_ARG if device is NULL, or MOBILE_IMAGE_MOUNTER_E_CONN_FAILED if the connection to the device could not be established.

| Improve this Doc View Source

mobile_image_mounter_start_service(iDeviceHandle, out MobileImageMounterClientHandle, String)

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

Declaration

MobileImageMounterError mobile_image_mounter_start_service(iDeviceHandle device, out MobileImageMounterClientHandle client, string label)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
MobileImageMounterClientHandle	client	Pointer that will point to a newly allocated mobile_image_mounter_t upon successful return. Must be freed using mobile_image_mounter_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
MobileImageMounterError	MOBILE_IMAGE_MOUNTER_E_SUCCESS on success, or an MOBILE_IMAGE_MOUNTER_E_* error code otherwise.

| Improve this Doc View Source

mobile_image_mounter_upload_image(MobileImageMounterClientHandle, String, UInt32, Byte[], UInt16, MobileImageMounterUploadCallBack, IntPtr)

Uploads an image with an optional signature to the device.

Declaration

MobileImageMounterError mobile_image_mounter_upload_image(MobileImageMounterClientHandle client, string imageType, uint imageSize, byte[] signature, ushort signatureSize, MobileImageMounterUploadCallBack uploadCallBack, IntPtr userdata)

Parameters

Type	Name	Description
MobileImageMounterClientHandle	client	The connected mobile_image_mounter client.
System.String	imageType
System.UInt32	imageSize
System.Byte[]	signature	Buffer with a signature of the image being uploaded. If NULL, no signature will be used.
System.UInt16	signatureSize
MobileImageMounterUploadCallBack	uploadCallBack
System.IntPtr	userdata	User defined data for the upload callback function.

Returns

Type	Description
MobileImageMounterError	MOBILE_IMAGE_MOUNTER_E_SUCCESS on succes, or a MOBILE_IMAGE_MOUNTER_E_* error code otherwise.