diff options
Diffstat (limited to 'include/libimobiledevice')
| -rw-r--r-- | include/libimobiledevice/afc.h | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/include/libimobiledevice/afc.h b/include/libimobiledevice/afc.h index 2f272e0..a3cde32 100644 --- a/include/libimobiledevice/afc.h +++ b/include/libimobiledevice/afc.h | |||
| @@ -139,37 +139,39 @@ afc_error_t afc_client_free(afc_client_t client); | |||
| 139 | * and blocksize on the accessed disk partition. | 139 | * and blocksize on the accessed disk partition. |
| 140 | * | 140 | * |
| 141 | * @param client The client to get device info for. | 141 | * @param client The client to get device info for. |
| 142 | * @param infos A char ** list of parameters as given by AFC or NULL if there | 142 | * @param device_information A char list of device information terminated by an |
| 143 | * was an error. | 143 | * empty string or NULL if there was an error. Free with |
| 144 | * afc_dictionary_free(). | ||
| 144 | * | 145 | * |
| 145 | * @return AFC_E_SUCCESS on success or an AFC_E_* error value. | 146 | * @return AFC_E_SUCCESS on success or an AFC_E_* error value. |
| 146 | */ | 147 | */ |
| 147 | afc_error_t afc_get_device_info(afc_client_t client, char ***infos); | 148 | afc_error_t afc_get_device_info(afc_client_t client, char ***device_information); |
| 148 | 149 | ||
| 149 | /** | 150 | /** |
| 150 | * Gets a directory listing of the directory requested. | 151 | * Gets a directory listing of the directory requested. |
| 151 | * | 152 | * |
| 152 | * @param client The client to get a directory listing from. | 153 | * @param client The client to get a directory listing from. |
| 153 | * @param dir The directory to list. (must be a fully-qualified path) | 154 | * @param path The directory for listing. (must be a fully-qualified path) |
| 154 | * @param list A char list of files in that directory, terminated by an empty | 155 | * @param directory_information A char list of files in the directory |
| 155 | * string or NULL if there was an error. | 156 | * terminated by an empty string or NULL if there was an error. Free with |
| 157 | * afc_dictionary_free(). | ||
| 156 | * | 158 | * |
| 157 | * @return AFC_E_SUCCESS on success or an AFC_E_* error value. | 159 | * @return AFC_E_SUCCESS on success or an AFC_E_* error value. |
| 158 | */ | 160 | */ |
| 159 | afc_error_t afc_read_directory(afc_client_t client, const char *dir, char ***list); | 161 | afc_error_t afc_read_directory(afc_client_t client, const char *path, char ***directory_information); |
| 160 | 162 | ||
| 161 | /** | 163 | /** |
| 162 | * Gets information about a specific file. | 164 | * Gets information about a specific file. |
| 163 | * | 165 | * |
| 164 | * @param client The client to use to get the information of the file. | 166 | * @param client The client to use to get the information of the file. |
| 165 | * @param path The fully-qualified path to the file. | 167 | * @param path The fully-qualified path to the file. |
| 166 | * @param infolist Pointer to a buffer that will be filled with a NULL-terminated | 168 | * @param file_information Pointer to a buffer that will be filled with a |
| 167 | * list of strings with the file information. | 169 | * NULL-terminated list of strings with the file information. Set to NULL |
| 168 | * Set to NULL before calling this function. | 170 | * before calling this function. Free with afc_dictionary_free(). |
| 169 | * | 171 | * |
| 170 | * @return AFC_E_SUCCESS on success or an AFC_E_* error value. | 172 | * @return AFC_E_SUCCESS on success or an AFC_E_* error value. |
| 171 | */ | 173 | */ |
| 172 | afc_error_t afc_get_file_info(afc_client_t client, const char *filename, char ***infolist); | 174 | afc_error_t afc_get_file_info(afc_client_t client, const char *filename, char ***file_information); |
| 173 | 175 | ||
| 174 | /** | 176 | /** |
| 175 | * Opens a file on the device. | 177 | * Opens a file on the device. |
| @@ -296,12 +298,12 @@ afc_error_t afc_rename_path(afc_client_t client, const char *from, const char *t | |||
| 296 | * Creates a directory on the device. | 298 | * Creates a directory on the device. |
| 297 | * | 299 | * |
| 298 | * @param client The client to use to make a directory. | 300 | * @param client The client to use to make a directory. |
| 299 | * @param dir The directory's path. (must be a fully-qualified path, I assume | 301 | * @param path The directory's path. (must be a fully-qualified path, I assume |
| 300 | * all other mkdir restrictions apply as well) | 302 | * all other mkdir restrictions apply as well) |
| 301 | * | 303 | * |
| 302 | * @return AFC_E_SUCCESS on success or an AFC_E_* error value. | 304 | * @return AFC_E_SUCCESS on success or an AFC_E_* error value. |
| 303 | */ | 305 | */ |
| 304 | afc_error_t afc_make_directory(afc_client_t client, const char *dir); | 306 | afc_error_t afc_make_directory(afc_client_t client, const char *path); |
| 305 | 307 | ||
| 306 | /** | 308 | /** |
| 307 | * Sets the size of a file on the device without prior opening it. | 309 | * Sets the size of a file on the device without prior opening it. |
