documented import_keys' private_keys parameter
authorEdouard Tisserant
Wed, 29 Jun 2016 14:46:03 +0200
changeset 77277bafcb71517
parent 771 c04f54a73ef8
child 773 26b63b76518e
documented import_keys' private_keys parameter
src/pEpEngine.h
     1.1 --- a/src/pEpEngine.h	Wed Jun 29 12:10:15 2016 +0200
     1.2 +++ b/src/pEpEngine.h	Wed Jun 29 14:46:03 2016 +0200
     1.3 @@ -549,11 +549,16 @@
     1.4  //      session (in)            session handle
     1.5  //      key_data (in)           key data, i.e. ASCII armored OpenPGP key
     1.6  //      size (in)               amount of data to handle
     1.7 +//      private_keys (out)      list of private keys that have been imported
     1.8  //
     1.9  //  return value:
    1.10  //      PEP_STATUS_OK = 0       key was successfully imported
    1.11  //      PEP_OUT_OF_MEMORY       out of memory
    1.12  //      PEP_ILLEGAL_VALUE       there is no key data to import
    1.13 +//
    1.14 +//  caveat:
    1.15 +//      private_keys goes to the ownership of the caller
    1.16 +//      private_keys can be left NULL, it is then ignored
    1.17  
    1.18  DYNAMIC_API PEP_STATUS import_key(
    1.19          PEP_SESSION session,