aboutsummaryrefslogtreecommitdiffstats
path: root/doc/gpgme.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/gpgme.texi')
-rw-r--r--doc/gpgme.texi9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index 2663f075..7c114b47 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -1803,7 +1803,7 @@ The function @code{gpgme_key_release} is an alias for
@cindex key, creation
@cindex key ring, add
-@deftypefun GpgmeError gpgme_op_genkey (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{pubkey}}, @w{GpgmeData @var{seckey}})
+@deftypefun GpgmeError gpgme_op_genkey (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{pubkey}}, @w{GpgmeData @var{seckey}}, @w{char **@var{fpr}})
The function @code{gpgme_op_genkey} generates a new key pair in the
context @var{ctx} and puts it into the standard key ring if both
@var{pubkey} and @var{seckey} are @code{NULL}. In this case the
@@ -1856,6 +1856,13 @@ for now is ``internal''. The content of the @code{GnupgKeyParms}
container is passed verbatim to GnuPG. Control statements are not
allowed.
+If @var{fpr} is not a null pointer, the function succeeds, and the
+crypto engine supports it, *@var{fpr} will contain a string with the
+fingerprint of the key, allocated with @code{malloc}. If both a
+primary and a sub key was generated, the fingerprint of the primary
+key will be returned. If the crypto engine does not provide the
+fingerprint, *@var{fpr} will be a null pointer.
+
The function returns @code{GPGME_No_Error} if the operation could be
started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not
a valid XML string, @code{GPGME_Not_Supported} if @var{pubkey} or