aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorJustus Winter <[email protected]>2016-05-27 10:19:52 +0000
committerJustus Winter <[email protected]>2016-05-27 10:19:52 +0000
commite74cd9fb80f12b764d5e4561e73d55644147e9e7 (patch)
tree7f8c40dcfc864e258afa03eaefd24b2f51057463 /src
parentpython: Fix reading data from existing files. (diff)
downloadgpgme-e74cd9fb80f12b764d5e4561e73d55644147e9e7.tar.gz
gpgme-e74cd9fb80f12b764d5e4561e73d55644147e9e7.zip
Improve comments.
* src/gpgme.h.in (gpgme_data_seek_cb_t, gpgme_data_seek): Clarify that these functions return the new offset. (gpgme_data_release_cb_t): Fix name of parameter. Signed-off-by: Justus Winter <[email protected]>
Diffstat (limited to 'src')
-rw-r--r--src/gpgme.h.in10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/gpgme.h.in b/src/gpgme.h.in
index 335ed6b5..87550fe4 100644
--- a/src/gpgme.h.in
+++ b/src/gpgme.h.in
@@ -1196,11 +1196,12 @@ typedef @API__SSIZE_T@ (*gpgme_data_write_cb_t) (void *handle, const void *buffe
/* Set the current position from where the next read or write starts
in the data object with the handle HANDLE to OFFSET, relativ to
- WHENCE. */
+ WHENCE. Returns the new offset in bytes from the beginning of the
+ data object. */
typedef @API__OFF_T@ (*gpgme_data_seek_cb_t) (void *handle,
@API__OFF_T@ offset, int whence);
-/* Close the data object with the handle DL. */
+/* Close the data object with the handle HANDLE. */
typedef void (*gpgme_data_release_cb_t) (void *handle);
struct gpgme_data_cbs
@@ -1223,8 +1224,9 @@ typedef struct gpgme_data_cbs *gpgme_data_cbs_t;
@API__SSIZE_T@ gpgme_data_write (gpgme_data_t dh, const void *buffer, size_t size);
/* Set the current position from where the next read or write starts
- in the data object with the handle DH to OFFSET, relativ to
- WHENCE. */
+ in the data object with the handle DH to OFFSET, relativ to WHENCE.
+ Returns the new offset in bytes from the beginning of the data
+ object. */
@API__OFF_T@ gpgme_data_seek (gpgme_data_t dh, @API__OFF_T@ offset, int whence);
/* Create a new data buffer and return it in R_DH. */