GNU Info

(gpgme.info)Key Listing Mode

---

Next: Passphrase Callback Prev: Included Certificates Up: Context Attributes

---

Enter node , (file) or (file)node

Key Listing Mode
----------------

 - Function: void gpgme_set_keylist_mode (GpgmeCtx CTX, int MODE)
     The function `gpgme_set_keylist_mode' changes the default
     behaviour of the key listing functions.  The value in MODE is a
     bitwise-or combination of one or multiple of the following bit
     values:

    `GPGME_KEYLIST_MODE_LOCAL'
          The `GPGME_KEYLIST_MODE_LOCAL' symbol specifies that the local
          keyring should be searched for keys in the keylisting
          operation.  This is the default.

    `GPGME_KEYLIST_MODE_EXTERN'
          The `GPGME_KEYLIST_MODE_EXTERN' symbol specifies that an
          external source should be should be searched for keys in the
          keylisting operation.  The type of external source is
          dependant on the crypto engine used.  For example, it can be
          a remote keyserver or LDAP certificate server.

     At least one of `GPGME_KEYLIST_MODE_LOCAL' and
     `GPGME_KEYLIST_MODE_EXTERN' must be specified.  For future binary
     compatibility, you should get the current mode with
     `gpgme_get_keylist_mode' and modify it by setting or clearing the
     appropriate bits, and then using that calulcated value in the
     `gpgme_set_keylisting_mode' operation.  This will leave all other
     bits in the mode value intact (in particular those that are not
     used in the current version of the library).

     The function returns `GPGME_No_Error' if the mode could be set
     correctly, and `GPGME_Invalid_Value' if CTX is not a valid pointer
     or MODE is not a valid mode.

 - Function: int gpgme_get_keylist_mode (GpgmeCtx CTX)
     The function `gpgme_get_keylist_mode' returns the current key
     listing mode of the context CTX.  This value can then be modified
     and used in a subsequent `gpgme_set_keylist_mode' operation to
     only affect the desired bits (and leave all others intact).

     The function returns 0 if CTX is not a valid pointer, and the
     current mode otherwise.  Note that 0 is not a valid mode value.