GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Clarify import keys operation further.

Browse Source 
* doc/gpgme.texi (gpgme_op_import_keys): Further clarifications.

Signed-off-by: Marcus Brinkmann <mb@g10code.com>
GnuPG-bug-id: 3215
This commit is contained in:
Marcus Brinkmann 2017-08-16 15:39:17 +02:00
parent 3244d4daff
commit 0ee7f4f178
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/gpgme.texi
View File

@ -4458,9 +4458,12 @@ The function @code{gpgme_op_import_keys} adds the keys described by
the @code{NULL} terminated array @var{keys} to the key ring of the the @code{NULL} terminated array @var{keys} to the key ring of the
crypto engine used by @var{ctx}. It is used to actually import and crypto engine used by @var{ctx}. It is used to actually import and
make keys permanent which have been retrieved from an external source make keys permanent which have been retrieved from an external source
(i.e. using @code{GPGME_KEYLIST_MODE_EXTERN}). @footnote{Thus it is a (i.e. using @code{GPGME_KEYLIST_MODE_EXTERN}) earlier. The external
keylisting must have been made with the same context configuration (in
particular the same home directory). @footnote{Thus it is a
replacement for the usual workaround of exporting and then importing a replacement for the usual workaround of exporting and then importing a
key to make an X.509 key permanent.} key to make an X.509 key permanent.} Note that for OpenPGP this may
require another access to the keyserver over the network.
Only keys of the currently selected protocol of @var{ctx} are Only keys of the currently selected protocol of @var{ctx} are
considered for import. Other keys specified by the @var{keys} are considered for import. Other keys specified by the @var{keys} are
@ -4470,6 +4473,9 @@ the same method, i.e. the used key listing mode must be identical.
After the operation completed successfully, the result can be After the operation completed successfully, the result can be
retrieved with @code{gpgme_op_import_result}. retrieved with @code{gpgme_op_import_result}.
To move keys from one home directory to another, export and import the
keydata using @code{gpgme_op_export} and @code{gpgme_op_import}.
The function returns the error code @code{GPG_ERR_NO_ERROR} if the The function returns the error code @code{GPG_ERR_NO_ERROR} if the
import was completed successfully, @code{GPG_ERR_INV_VALUE} if import was completed successfully, @code{GPG_ERR_INV_VALUE} if
@var{ctx} is not a valid pointer, @code{GPG_ERR_CONFLICT} if the key @var{ctx} is not a valid pointer, @code{GPG_ERR_CONFLICT} if the key