diff options
Diffstat (limited to 'include/libimobiledevice/libimobiledevice.h')
| -rw-r--r-- | include/libimobiledevice/libimobiledevice.h | 32 |
1 files changed, 28 insertions, 4 deletions
diff --git a/include/libimobiledevice/libimobiledevice.h b/include/libimobiledevice/libimobiledevice.h index c1d5460..8bf022a 100644 --- a/include/libimobiledevice/libimobiledevice.h +++ b/include/libimobiledevice/libimobiledevice.h | |||
| @@ -124,25 +124,49 @@ idevice_error_t idevice_event_unsubscribe(void); | |||
| 124 | /* discovery (synchronous) */ | 124 | /* discovery (synchronous) */ |
| 125 | 125 | ||
| 126 | /** | 126 | /** |
| 127 | * Get a list of currently available devices. | 127 | * Get a list of UDIDs of currently available devices (USBMUX devices only). |
| 128 | * | 128 | * |
| 129 | * @param devices List of udids of devices that are currently available. | 129 | * @param devices List of UDIDs of devices that are currently available. |
| 130 | * This list is terminated by a NULL pointer. | 130 | * This list is terminated by a NULL pointer. |
| 131 | * @param count Number of devices found. | 131 | * @param count Number of devices found. |
| 132 | * | 132 | * |
| 133 | * @return IDEVICE_E_SUCCESS on success or an error value when an error occurred. | 133 | * @return IDEVICE_E_SUCCESS on success or an error value when an error occurred. |
| 134 | * | ||
| 135 | * @note This function only returns the UDIDs of USBMUX devices. To also include | ||
| 136 | * network devices in the list, use idevice_get_device_list_extended(). | ||
| 137 | * @see idevice_get_device_list_extended | ||
| 134 | */ | 138 | */ |
| 135 | idevice_error_t idevice_get_device_list(char ***devices, int *count); | 139 | idevice_error_t idevice_get_device_list(char ***devices, int *count); |
| 136 | 140 | ||
| 137 | /** | 141 | /** |
| 138 | * Free a list of device udids. | 142 | * Free a list of device UDIDs. |
| 139 | * | 143 | * |
| 140 | * @param devices List of udids to free. | 144 | * @param devices List of UDIDs to free. |
| 141 | * | 145 | * |
| 142 | * @return Always returnes IDEVICE_E_SUCCESS. | 146 | * @return Always returnes IDEVICE_E_SUCCESS. |
| 143 | */ | 147 | */ |
| 144 | idevice_error_t idevice_device_list_free(char **devices); | 148 | idevice_error_t idevice_device_list_free(char **devices); |
| 145 | 149 | ||
| 150 | /** | ||
| 151 | * Get a list of currently available devices | ||
| 152 | * | ||
| 153 | * @param devices List of idevice_info_t records with device information. | ||
| 154 | * This list is terminated by a NULL pointer. | ||
| 155 | * @param count Number of devices included in the list. | ||
| 156 | * | ||
| 157 | * @return IDEVICE_E_SUCCESS on success or an error value when an error occurred. | ||
| 158 | */ | ||
| 159 | idevice_error_t idevice_get_device_list_extended(idevice_info_t **devices, int *count); | ||
| 160 | |||
| 161 | /** | ||
| 162 | * Free an extended device list retrieved through idevice_get_device_list_extended(). | ||
| 163 | * | ||
| 164 | * @param devices Device list to free. | ||
| 165 | * | ||
| 166 | * @return IDEVICE_E_SUCCESS on success or an error value when an error occurred. | ||
| 167 | */ | ||
| 168 | idevice_error_t idevice_device_list_extended_free(idevice_info_t *devices); | ||
| 169 | |||
| 146 | /* device structure creation and destruction */ | 170 | /* device structure creation and destruction */ |
| 147 | 171 | ||
| 148 | /** | 172 | /** |
