ENGINE-148 update documentation of encrypt_message()
authorEdouard Tisserant <edouard@pep-project.org>
Wed, 14 Jun 2017 16:45:54 +0200
changeset 1854b76315c0117d
parent 1853 a86d6290d493
child 1857 52e46f43ac67
child 1858 600dc0395ec0
ENGINE-148 update documentation of encrypt_message()
src/message_api.h
     1.1 --- a/src/message_api.h	Tue Jun 13 21:15:16 2017 +0200
     1.2 +++ b/src/message_api.h	Wed Jun 14 16:45:54 2017 +0200
     1.3 @@ -47,11 +47,14 @@
     1.4  //
     1.5  //  return value:
     1.6  //      PEP_STATUS_OK                   on success
     1.7 -//		PEP_KEY_NOT_FOUND	            at least one of the receipient keys
     1.8 -//		                                could not be found
     1.9 -//		PEP_KEY_HAS_AMBIG_NAME          at least one of the receipient keys has
    1.10 -//		                                an ambiguous name
    1.11 -//		PEP_GET_KEY_FAILED		        cannot retrieve key
    1.12 +//      PEP_KEY_NOT_FOUND	            at least one of the receipient keys
    1.13 +//                                      could not be found
    1.14 +//      PEP_KEY_HAS_AMBIG_NAME          at least one of the receipient keys has
    1.15 +//                                      an ambiguous name
    1.16 +//      PEP_GET_KEY_FAILED		        cannot retrieve key
    1.17 +//      PEP_UNENCRYPTED                 no recipients with usable key, 
    1.18 +//                                      message is left unencrypted,
    1.19 +//                                      and key is attached to it
    1.20  //
    1.21  //	caveat:
    1.22  //	    the ownershop of src remains with the caller