libiphone/libiphone.h File Reference

Common code and device handling. More...

Defines
#define	IPHONE_E_SUCCESS   0
#define	IPHONE_E_INVALID_ARG   -1
#define	IPHONE_E_UNKNOWN_ERROR   -2
#define	IPHONE_E_NO_DEVICE   -3
#define	IPHONE_E_NOT_ENOUGH_DATA   -4
#define	IPHONE_E_BAD_HEADER   -5
#define	DBGMASK_ALL   0xFFFF
#define	DBGMASK_NONE   0x0000
#define	DBGMASK_LOCKDOWND   (1 << 1)
#define	DBGMASK_MOBILESYNC   (1 << 2)
Typedefs
typedef int16_t	iphone_error_t
typedef struct iphone_device_int *	iphone_device_t
Functions
void	iphone_set_debug_mask (uint16_t mask)
	Set debug ids to display.
void	iphone_set_debug_level (int level)
	Sets the level of debugging.
iphone_error_t	iphone_get_device (iphone_device_t *device)
	This function has the purpose to retrieve a handle to the first attached iPhone/iPod reported by usbmuxd.
iphone_error_t	iphone_get_device_by_uuid (iphone_device_t *device, const char *uuid)
	Retrieves a list of connected devices from usbmuxd and matches their UUID with the given UUID.
iphone_error_t	iphone_device_free (iphone_device_t device)
	Cleans up an iPhone structure, then frees the structure itself.
iphone_error_t	iphone_device_get_handle (iphone_device_t device, uint32_t *handle)
iphone_error_t	iphone_device_get_uuid (iphone_device_t device, char **uuid)

---

Detailed Description

Common code and device handling.

---

Function Documentation

iphone_error_t iphone_device_free

(

iphone_device_t

device

)

Cleans up an iPhone structure, then frees the structure itself.

This is a library-level function; deals directly with the iPhone to tear down relations, but otherwise is mostly internal.

Parameters:

phone

A pointer to an iPhone structure.

iphone_error_t iphone_get_device

(

iphone_device_t *

device

)

This function has the purpose to retrieve a handle to the first attached iPhone/iPod reported by usbmuxd.

Parameters:

Upon

calling this function, a pointer to a location of type iphone_device_t, which must have the value NULL. On return, this location will be filled with a handle to the device.

Returns:

IPHONE_E_SUCCESS if ok, otherwise an error code.

iphone_error_t iphone_get_device_by_uuid	(	iphone_device_t *	device,
		const char *	uuid
	)

Retrieves a list of connected devices from usbmuxd and matches their UUID with the given UUID.

If the given UUID is NULL then the first device reported by usbmuxd is used.

Parameters:

	device	Upon calling this function, a pointer to a location of type iphone_device_t, which must have the value NULL. On return, this location will be filled with a handle to the device.
	uuid	The UUID to match.

Returns:

IPHONE_E_SUCCESS if ok, otherwise an error code.

void iphone_set_debug_level

(

int

level

)

Sets the level of debugging.

Currently the only acceptable values are 0 and 1.

Parameters:

level

Set to 0 for no debugging or 1 for debugging.

void iphone_set_debug_mask

(

uint16_t

mask

)

Set debug ids to display.

Values can be OR-ed

Parameters:

level

Set to 0 for no debugging or 1 for debugging.