aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorWerner Koch <[email protected]>2016-09-15 07:24:29 +0000
committerWerner Koch <[email protected]>2016-09-15 07:24:29 +0000
commitd2b72d3cc19fe2a7d548dac38d55e069e0c9a904 (patch)
tree9287ba936a5f8d80a61503d23bc5e4709645bb14 /doc
parentcore: New function gpgme_op_tofu_policy (diff)
downloadgpgme-d2b72d3cc19fe2a7d548dac38d55e069e0c9a904.tar.gz
gpgme-d2b72d3cc19fe2a7d548dac38d55e069e0c9a904.zip
core: Minor change of the gpgme_op_edit semantics.
* src/edit.c (command_handler): Handle special error code. * src/engine-gpg.c (read_status): Ditto. * src/engine-gpgsm.c (status_handler): Ditto. * src/engine-uiserver.c (status_handler): Ditto. * src/util.h (GPG_ERR_FALSE): Define for older libgpg-error versions. -- An edit callback may now simply return GPG_ERR_FALSE to indicate that it did not handled the status code. GPGME will the do the appropriate action, which is to send an empty line. Note that it is highly unlikely that GPG_ERR_FALSE has ever been used by an application as return value from an edit interactor. Signed-off-by: Werner Koch <[email protected]>
Diffstat (limited to 'doc')
-rw-r--r--doc/gpgme.texi3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index ef39d81b..a4a08143 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -4312,7 +4312,8 @@ indicates a command rather than a status message, the response to the
command should be written to @var{fd}. The @var{handle} is provided
by the user at start of operation.
-The function should return @code{GPG_ERR_NO_ERROR} or an error value.
+The function should return @code{GPG_ERR_FALSE} if it did not handle
+the status code, @code{0} for success, or any other error value.
@end deftp
@deftypefun gpgme_error_t gpgme_op_edit (@w{gpgme_ctx_t @var{ctx}}, @w{gpgme_key_t @var{key}}, @w{gpgme_edit_cb_t @var{fnc}}, @w{void *@var{handle}}, @w{gpgme_data_t @var{out}})