|  |  |  | libcryptui Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | ||||
CryptUIKeysetPrivate; struct CryptUIKeyset; CryptUIKeyset * cryptui_keyset_new (const gchar *keytype,gboolean expand_keys); gboolean cryptui_keyset_has_key (CryptUIKeyset *keyset,const gchar *key); const gchar * cryptui_keyset_get_keytype (CryptUIKeyset *keyset); GList * cryptui_keyset_get_keys (CryptUIKeyset *keyset); guint cryptui_keyset_get_count (CryptUIKeyset *keyset); void cryptui_keyset_refresh (CryptUIKeyset *keyset); gpointer cryptui_keyset_get_closure (CryptUIKeyset *keyset,const gchar *key); void cryptui_keyset_set_closure (CryptUIKeyset *keyset,const gchar *key,gpointer closure); gboolean cryptui_keyset_get_expand_keys (CryptUIKeyset *keyset); void cryptui_keyset_set_expand_keys (CryptUIKeyset *keyset,gboolean expand_keys); void cryptui_keyset_cache_key (CryptUIKeyset *keyset,const gchar *key); gchar * cryptui_keyset_key_get_string (CryptUIKeyset *keyset,const gchar *key,const gchar *prop); guint cryptui_keyset_key_get_uint (CryptUIKeyset *keyset,const gchar *key,const gchar *prop); guint cryptui_keyset_key_flags (CryptUIKeyset *keyset,const gchar *key); gchar * cryptui_keyset_key_display_name (CryptUIKeyset *keyset,const gchar *key); gchar * cryptui_keyset_key_display_id (CryptUIKeyset *keyset,const gchar *key); gchar * cryptui_keyset_key_raw_keyid (CryptUIKeyset *keyset,const gchar *key); gchar ** cryptui_keyset_keys_raw_keyids (CryptUIKeyset *keyset,const gchar **keys);
CryptUIKeyset * cryptui_keyset_new (const gchar *keytype,gboolean expand_keys);
Creates a new keylist
| 
 | libcryptui key prefix | 
| 
 | whether key's non-primary uids are part of the set | 
| Returns : | the new keyset | 
gboolean cryptui_keyset_has_key (CryptUIKeyset *keyset,const gchar *key);
Determines whether or not a key is present in the keyset
| 
 | a libcryptui keyset | 
| 
 | a libcryptui key | 
| Returns : | TRUE if the key is present, FALSE otherwise | 
const gchar *       cryptui_keyset_get_keytype          (CryptUIKeyset *keyset);
Gets the libcryptui key prefix for the keyset
| 
 | a libcryptui keyset | 
| Returns : | a libcryptui key prefix | 
GList *             cryptui_keyset_get_keys             (CryptUIKeyset *keyset);
Gets a list of keys contained in the key set
| 
 | a libcryptui keyset | 
| Returns : | a doubly linked list of keys | 
guint               cryptui_keyset_get_count            (CryptUIKeyset *keyset);
Gets the number of keys stored in the keyset
| 
 | a libcryptui keyset | 
| Returns : | the number of keys | 
void                cryptui_keyset_refresh              (CryptUIKeyset *keyset);
Checks the remote keyset to see which keys have been added or removed
| 
 | a libcryptui keyset | 
gpointer cryptui_keyset_get_closure (CryptUIKeyset *keyset,const gchar *key);
TODO: Find out what closure is and document this function
| 
 | a libcryptui keyset | 
| 
 | a libcryptui key | 
| Returns : | closure associated with key | 
void cryptui_keyset_set_closure (CryptUIKeyset *keyset,const gchar *key,gpointer closure);
TODO: Find out what closure is and document this function
| 
 | a libcryptui keyset | 
| 
 | a libcryptui key | 
| 
 | TODO | 
gboolean            cryptui_keyset_get_expand_keys      (CryptUIKeyset *keyset);
Gets whether or not non-primary key UIDs are included in the keyset
| 
 | a libcryptui keyset | 
| Returns : | TRUE if non-primary key UIDs are included in the keyset | 
void cryptui_keyset_set_expand_keys (CryptUIKeyset *keyset,gboolean expand_keys);
Sets whether or not non-primary key UIDs are included in the keyset
| 
 | a libcryptui keyset | 
| 
 | a gboolean | 
void cryptui_keyset_cache_key (CryptUIKeyset *keyset,const gchar *key);
Stores the key's fields returned by the DBus method GetKeyFields in the keyset.
| 
 | a libcryptui keyset | 
| 
 | libcryptui key to cache | 
gchar * cryptui_keyset_key_get_string (CryptUIKeyset *keyset,const gchar *key,const gchar *prop);
Gets the given property of the key in the keyset.
| 
 | a libcryptui keyset | 
| 
 | libcryptui key to fetch a property of | 
| 
 | string property to get | 
| Returns : | a string containing the property's value | 
guint cryptui_keyset_key_get_uint (CryptUIKeyset *keyset,const gchar *key,const gchar *prop);
Gets the given property of the key in the keyset.
| 
 | a libcryptui keyset | 
| 
 | libcryptui key to fetch a property of | 
| 
 | uint property to get | 
| Returns : | a uint containing the property's value | 
guint cryptui_keyset_key_flags (CryptUIKeyset *keyset,const gchar *key);
Gets the key's flags
| 
 | a libcryptui keyset | 
| 
 | a libcryptui key | 
| Returns : | a uint containing the flags | 
gchar * cryptui_keyset_key_display_name (CryptUIKeyset *keyset,const gchar *key);
Gets the "display-name" property of the given key
| 
 | a libcryptui keyset | 
| 
 | a libcryptui key | 
| Returns : | the display name of the key | 
gchar * cryptui_keyset_key_display_id (CryptUIKeyset *keyset,const gchar *key);
Gets the "display-id" property of the given key
| 
 | a libcryptui keyset | 
| 
 | a libcryptui key | 
| Returns : | the display id of the key | 
gchar * cryptui_keyset_key_raw_keyid (CryptUIKeyset *keyset,const gchar *key);
Gets the key's raw key id
| 
 | a libcryptui keyset | 
| 
 | a libcryptui key | 
| Returns : | a string with the raw key id | 
gchar ** cryptui_keyset_keys_raw_keyids (CryptUIKeyset *keyset,const gchar **keys);
Gets the keys' raw key ids
| 
 | a libcryptui keyset | 
| 
 | an array of libcryptui keys | 
| Returns : | an array of raw key ids |