libimobiledevice  1.3.0
API Documentation - Return to Homepage

◆ idevice_new_with_options()

idevice_error_t idevice_new_with_options ( idevice_t device,
const char *  udid,
enum idevice_options  options 
)

Creates an idevice_t structure for the device specified by UDID, if the device is available, with the given lookup options.

Note
The resulting idevice_t structure has to be freed with idevice_free() if it is no longer used.
Parameters
deviceUpon calling this function, a pointer to a location of type idevice_t. On successful return, this location will be populated.
udidThe UDID to match.
optionsSpecifies what connection types should be considered when looking up devices. Accepts bitwise or'ed values of idevice_options. If 0 (no option) is specified it will default to IDEVICE_LOOKUP_USBMUX. To lookup both USB and network-connected devices, pass IDEVICE_LOOKUP_USBMUX | IDEVICE_LOOKUP_NETWORK. If a device is available both via USBMUX and network, it will select the USB connection. This behavior can be changed by adding IDEVICE_LOOKUP_PREFER_NETWORK to the options in which case it will select the network connection.
Returns
IDEVICE_E_SUCCESS if ok, otherwise an error code.