aboutsummaryrefslogtreecommitdiffstats
path: root/libcoopgamma_error_destroy.c
diff options
context:
space:
mode:
Diffstat (limited to 'libcoopgamma_error_destroy.c')
-rw-r--r--libcoopgamma_error_destroy.c19
1 files changed, 19 insertions, 0 deletions
diff --git a/libcoopgamma_error_destroy.c b/libcoopgamma_error_destroy.c
new file mode 100644
index 0000000..0e7fa54
--- /dev/null
+++ b/libcoopgamma_error_destroy.c
@@ -0,0 +1,19 @@
+/* See LICENSE file for copyright and license details. */
+#include "common.h"
+
+
+/**
+ * Release all resources allocated to a `libcoopgamma_error_t`,
+ * the allocation of the record itself is not freed
+ *
+ * Always call this function after failed call to `libcoopgamma_error_initialise`
+ * or failed call to `libcoopgamma_error_unmarshal`
+ *
+ * @param this The record to destroy
+ */
+void
+libcoopgamma_error_destroy(libcoopgamma_error_t *restrict this)
+{
+ free(this->description);
+ this->description = NULL;
+}