Read Keyring
[Keys and Keyrings]


Functions

ops_boolean_t ops_keyring_read_from_file (ops_keyring_t *keyring, const ops_boolean_t armour, const char *filename)
 Reads a keyring from a file.
ops_boolean_t ops_keyring_read_from_mem (ops_keyring_t *keyring, const ops_boolean_t armour, ops_memory_t *mem)
 Reads a keyring from memory.
void ops_keyring_free (ops_keyring_t *keyring)
 Frees keyring's contents (but not keyring itself).

Function Documentation

void ops_keyring_free ops_keyring_t keyring  ) 
 

Frees keyring's contents (but not keyring itself).

Parameters:
keyring Keyring whose data is to be freed
Note:
This does not free keyring itself, just the memory alloc-ed in it.

ops_boolean_t ops_keyring_read_from_file ops_keyring_t keyring,
const ops_boolean_t  armour,
const char *  filename
 

Reads a keyring from a file.

Parameters:
keyring Pointer to an existing ops_keyring_t struct
armour ops_true if file is armoured; else ops_false
filename Filename of keyring to be read
Returns:
ops true if OK; ops_false on error
Note:
Keyring struct must already exist.

Can be used with either a public or secret keyring.

You must call ops_keyring_free() after usage to free alloc-ed memory.

If you call this twice on the same keyring struct, without calling ops_keyring_free() between these calls, you will introduce a memory leak.

See also:
ops_keyring_read_from_mem()

ops_keyring_free()

Example code:
   ops_keyring_t* keyring=ops_mallocz(sizeof *keyring);
   ops_boolean_t armoured=ops_false;
   ops_keyring_read_from_file(keyring, armoured, "~/.gnupg/pubring.gpg");
   ...
   ops_keyring_free(keyring);
   free (keyring);

ops_boolean_t ops_keyring_read_from_mem ops_keyring_t keyring,
const ops_boolean_t  armour,
ops_memory_t mem
 

Reads a keyring from memory.

Parameters:
keyring Pointer to existing ops_keyring_t struct
armour ops_true if file is armoured; else ops_false
mem Pointer to a ops_memory_t struct containing keyring to be read
Returns:
ops true if OK; ops_false on error
Note:
Keyring struct must already exist.

Can be used with either a public or secret keyring.

You must call ops_keyring_free() after usage to free alloc-ed memory.

If you call this twice on the same keyring struct, without calling ops_keyring_free() between these calls, you will introduce a memory leak.

See also:
ops_keyring_read_from_file

ops_keyring_free

Example code:
   ops_memory_t* mem; // Filled with keyring packets
   ops_keyring_t* keyring=ops_mallocz(sizeof *keyring);
   ops_boolean_t armoured=ops_false;
   ops_keyring_read_from_mem(keyring, armoured, mem);
   ...
   ops_keyring_free(keyring);
   free (keyring);


Generated on Tue May 21 00:00:02 2013 for OpenPGP:SDK by  doxygen 1.4.6