From 6546989d280d8fc1e8e2bc152f08d9b04090d4b8 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 13 Apr 2021 17:29:14 +0200 Subject: m + add section 3 man pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- libcontacts_contact_destroy.3 | 44 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 libcontacts_contact_destroy.3 (limited to 'libcontacts_contact_destroy.3') 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 + +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) -- cgit v1.2.3-70-g09d2