diff options
| author | Mattias Andrée <maandree@kth.se> | 2021-04-13 17:29:14 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2021-04-13 17:29:14 +0200 |
| commit | 6546989d280d8fc1e8e2bc152f08d9b04090d4b8 (patch) | |
| tree | d201c83a72d9ef296773794d0cfce6dd7ecab7e0 /libcontacts_contact_destroy.3 | |
| parent | Update todo: do not support multiple calendars, all birthdays shall be stored in gregorian, and other software shall convert (diff) | |
| download | libcontacts-6546989d280d8fc1e8e2bc152f08d9b04090d4b8.tar.gz libcontacts-6546989d280d8fc1e8e2bc152f08d9b04090d4b8.tar.bz2 libcontacts-6546989d280d8fc1e8e2bc152f08d9b04090d4b8.tar.xz | |
m + add section 3 man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libcontacts_contact_destroy.3')
| -rw-r--r-- | libcontacts_contact_destroy.3 | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/libcontacts_contact_destroy.3 b/libcontacts_contact_destroy.3 new file mode 100644 index 0000000..910c245 --- /dev/null +++ b/libcontacts_contact_destroy.3 @@ -0,0 +1,44 @@ +.TH LIBCONTACTS_CONTACT_DESTROY 3 LIBCONTACTS +.SH NAME +libcontacts_contact_destroy \- Deallocate memory for a contact entry +.SH SYNOPSIS +.nf +#include <libcontacts.h> + +int libcontacts_contact_destroy(struct libcontacts_contact *\fIentry\fP); +.fi +.PP +Link with +.IR -lcontacts . + +.SH DESCRIPTION +The +.BR libcontacts_contact_destroy () +function deallocates the memory stored in +.IR *entry , +including any subentries that are deallocatable +with other functions provided by libcontacts. +The caller must manually call +.BR free (3) +on the pointer +.I entry +afterwards if it a freeable pointer. + +.SH RETURN VALUE +None. + +.SH ERRORS +None. + +.SH SEE ALSO +.BR libcontacts.h (0), +.BR libcontacts (7), +.BR libcontacts_address_destroy (3), +.BR libcontacts_birthday_destroy (3), +.BR libcontacts_block_destroy (3), +.BR libcontacts_chat_destroy (3), +.BR libcontacts_email_destroy (3), +.BR libcontacts_number_destroy (3), +.BR libcontacts_organisation_destroy (3), +.BR libcontacts_pgpkey_destroy (3), +.BR libcontacts_site_destroy (3) |