diff options
| -rw-r--r-- | src/screenshotr.c | 12 | ||||
| -rw-r--r-- | src/screenshotr.h | 2 |
2 files changed, 9 insertions, 5 deletions
diff --git a/src/screenshotr.c b/src/screenshotr.c index f8866d0..11dce13 100644 --- a/src/screenshotr.c +++ b/src/screenshotr.c | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | /* | 1 | /* |
| 2 | * screenshotr.c | 2 | * screenshotr.c |
| 3 | * com.apple.mobile.screenshotr implementation. | 3 | * com.apple.mobile.screenshotr service implementation. |
| 4 | * | 4 | * |
| 5 | * Copyright (c) 2010 Nikias Bassen All Rights Reserved. | 5 | * Copyright (c) 2010 Nikias Bassen All Rights Reserved. |
| 6 | * | 6 | * |
| @@ -60,13 +60,16 @@ static screenshotr_error_t screenshotr_error(device_link_service_error_t err) | |||
| 60 | } | 60 | } |
| 61 | 61 | ||
| 62 | /** | 62 | /** |
| 63 | * Makes a connection to the screenshotr service on the device. | 63 | * Connects to the screenshotr service on the specified device. |
| 64 | * | 64 | * |
| 65 | * @param device The device to connect to. | 65 | * @param device The device to connect to. |
| 66 | * @param port Destination port (usually given by lockdownd_start_service). | 66 | * @param port Destination port (usually given by lockdownd_start_service). |
| 67 | * @param client Pointer that will be set to a newly allocated | 67 | * @param client Pointer that will be set to a newly allocated |
| 68 | * screenshotr_client_t upon successful return. | 68 | * screenshotr_client_t upon successful return. |
| 69 | * | 69 | * |
| 70 | * @note This service is only available if a developer disk image has been | ||
| 71 | * mounted. | ||
| 72 | * | ||
| 70 | * @return SCREENSHOTR_E_SUCCESS on success, SCREENSHOTR_E_INVALID ARG if one | 73 | * @return SCREENSHOTR_E_SUCCESS on success, SCREENSHOTR_E_INVALID ARG if one |
| 71 | * or more parameters are invalid, or SCREENSHOTR_E_CONN_FAILED if the | 74 | * or more parameters are invalid, or SCREENSHOTR_E_CONN_FAILED if the |
| 72 | * connection to the device could not be established. | 75 | * connection to the device could not be established. |
| @@ -100,9 +103,10 @@ screenshotr_error_t screenshotr_client_new(idevice_t device, uint16_t port, | |||
| 100 | } | 103 | } |
| 101 | 104 | ||
| 102 | /** | 105 | /** |
| 103 | * Disconnects a screenshotr client from the device. | 106 | * Disconnects a screenshotr client from the device and frees up the |
| 107 | * screenshotr client data. | ||
| 104 | * | 108 | * |
| 105 | * @param client The client to disconnect. | 109 | * @param client The screenshotr client to disconnect and free. |
| 106 | * | 110 | * |
| 107 | * @return SCREENSHOTR_E_SUCCESS on success, or SCREENSHOTR_E_INVALID_ARG | 111 | * @return SCREENSHOTR_E_SUCCESS on success, or SCREENSHOTR_E_INVALID_ARG |
| 108 | * if client is NULL. | 112 | * if client is NULL. |
diff --git a/src/screenshotr.h b/src/screenshotr.h index 5f842a7..97172dc 100644 --- a/src/screenshotr.h +++ b/src/screenshotr.h | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | /* | 1 | /* |
| 2 | * screenshotr.h | 2 | * screenshotr.h |
| 3 | * com.apple.mobile.screenshotr definitions. | 3 | * com.apple.mobile.screenshotr service header file. |
| 4 | * | 4 | * |
| 5 | * Copyright (c) 2010 Nikias Bassen All Rights Reserved. | 5 | * Copyright (c) 2010 Nikias Bassen All Rights Reserved. |
| 6 | * | 6 | * |
