aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcus Brinkmann <[email protected]>2002-04-22 21:58:26 +0000
committerMarcus Brinkmann <[email protected]>2002-04-22 21:58:26 +0000
commit025866092e14bb4ed68fe23140bf62dcce770cc5 (patch)
treed904c6391e2b17edc2ca0a9554aca0d15e1af1e9 /doc
parentMore fixes for certificate generation (diff)
downloadgpgme-025866092e14bb4ed68fe23140bf62dcce770cc5.tar.gz
gpgme-025866092e14bb4ed68fe23140bf62dcce770cc5.zip
doc/
2002-04-22 Marcus Brinkmann <[email protected]> * gpgme.texi (Passphrase Callback): Fix small typo. Document the new function gpgme_get_passphrase_cb. (Progress Meter Callback): Document the new function gpgme_get_progress_cb. gpgme/ 2002-04-22 Marcus Brinkmann <[email protected]> * gpgme.c (gpgme_get_passphrase_cb): New function. (gpgme_get_progress_cb): New function. * gpgme.h: Add new prototypes for gpgme_get_passphrase_cb and gpgme_get_progress_cb.
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog7
-rw-r--r--doc/gpgme.texi18
2 files changed, 24 insertions, 1 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 954014ad..b1257f5e 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,10 @@
+2002-04-22 Marcus Brinkmann <[email protected]>
+
+ * gpgme.texi (Passphrase Callback): Fix small typo. Document the
+ new function gpgme_get_passphrase_cb.
+ (Progress Meter Callback): Document the new function
+ gpgme_get_progress_cb.
+
2002-04-16 Marcus Brinkmann <[email protected]>
* gpgme.texi (Creating a Signature): Fix function name. Reported
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index 63568f56..63bfde7a 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -1153,7 +1153,7 @@ current mode otherwise. Note that 0 is not a valid mode value.
The @code{GpgmePassphraseCb} type is the type of functions usable as
passphrase callback function.
-The string @var{desc} contains a test usable to be displayed to the
+The string @var{desc} contains a text usable to be displayed to the
user of the application. The function should return a passphrase for
the context when invoked with @var{desc} not being @code{NULL}.
@@ -1182,6 +1182,14 @@ calling @code{gpgme_set_passphrase_cb} with @var{passfunc} being
@code{NULL}.
@end deftypefun
+@deftypefun void gpgme_get_passphrase_cb (@w{GpgmeCtx @var{ctx}}, @w{GpgmePassphraseCb *@var{passfunc}}, @w{void **@var{hook_value}})
+The function @code{gpgme_get_passphrase_cb} returns the function that
+is used when a passphrase needs to be provided by the user in
+@var{*passfunc}, and the first argument for this function in
+@var{*hook_value}. If no passphrase callback is set, or @var{ctx} is
+not a valid pointer, @code{NULL} is returned in both variables.
+@end deftypefun
+
@node Progress Meter Callback
@subsection Progress Meter Callback
@@ -1215,6 +1223,14 @@ calling @code{gpgme_set_progress_cb} with @var{progfunc} being
@code{NULL}.
@end deftypefun
+@deftypefun void gpgme_get_progress_cb (@w{GpgmeCtx @var{ctx}}, @w{GpgmeProgressCb *@var{progfunc}}, @w{void **@var{hook_value}})
+The function @code{gpgme_get_progress_cb} returns the function that is
+used to inform the user about the progress made in @var{*progfunc},
+and the first argument for this function in @var{*hook_value}. If no
+progress callback is set, or @var{ctx} is not a valid pointer,
+@code{NULL} is returned in both variables.
+@end deftypefun
+
@node Key Management
@section Key Management