aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorWerner Koch <[email protected]>2013-02-07 19:51:29 +0000
committerWerner Koch <[email protected]>2013-02-07 19:51:29 +0000
commit29eced50687dd8a39dafe704102ae09ea8e8533a (patch)
treec8bb9b47232807d90ec0525bdf8afb3c6186c3ee /doc
parentUse gpg_error_from_syserror instead of directly accessing errno. (diff)
downloadgpgme-29eced50687dd8a39dafe704102ae09ea8e8533a.tar.gz
gpgme-29eced50687dd8a39dafe704102ae09ea8e8533a.zip
Add public function gpgme_io_writen.
* src/gpgme.c (gpgme_io_read): New. -- This is a writen style variant for gpgme_io_write. It is often easier to use this one in passphrase and edit callbacks.
Diffstat (limited to 'doc')
-rw-r--r--doc/gpgme.texi7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index d074b429..b73f425c 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -2374,9 +2374,10 @@ previous attempts failed, then @var{prev_was_bad} is 1, otherwise it
will be 0.
The user must write the passphrase, followed by a newline character,
-to the file descriptor @var{fd}. If the user returns 0 indicating
-success, the user must at least write a newline character before
-returning from the callback.
+to the file descriptor @var{fd}. The function @code{gpgme_io_writen}
+should be used for the write operation. Note that if the user returns
+0 to indicate success, the user must at least write a newline
+character before returning from the callback.
If an error occurs, return the corresponding @code{gpgme_error_t}
value. You can use the error code @code{GPG_ERR_CANCELED} to abort