summaryrefslogtreecommitdiffstats
path: root/openpgp-ffi/include/sequoia/openpgp.h
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2020-02-04 17:11:11 +0100
committerJustus Winter <justus@sequoia-pgp.org>2020-02-05 11:44:31 +0100
commit4ea8a7ca6cb2cb78e36b9735428e248b3cd9c3bf (patch)
tree3a97e0ca4a9e5cc6f8b576b18dc8cae3188fe0e2 /openpgp-ffi/include/sequoia/openpgp.h
parent8d662becb65d3da9439a7fe1445ed6335d5637bf (diff)
openpgp-ffi: Provide pgp_armor_writer_finalize.
Diffstat (limited to 'openpgp-ffi/include/sequoia/openpgp.h')
-rw-r--r--openpgp-ffi/include/sequoia/openpgp.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/openpgp-ffi/include/sequoia/openpgp.h b/openpgp-ffi/include/sequoia/openpgp.h
index d15749d9..83c7416e 100644
--- a/openpgp-ffi/include/sequoia/openpgp.h
+++ b/openpgp-ffi/include/sequoia/openpgp.h
@@ -197,11 +197,21 @@ pgp_armor_header_t pgp_armor_reader_headers (pgp_error_t *errp,
/// Constructs a new filter for the given type of data.
///
/// A filter that applies ASCII Armor to the data written to it.
+///
+/// Note: You must call `pgp_armor_writer_finalize` to deallocate this
+/// writer.
/*/
pgp_writer_t pgp_armor_writer_new (pgp_error_t *errp, pgp_writer_t inner,
pgp_armor_kind_t kind,
pgp_armor_header_t header, size_t header_len);
+/*/
+/// Finalizes the armor writer.
+///
+/// Consumes the writer. No further deallocation of the writer is
+/// required.
+/*/
+pgp_status_t pgp_armor_writer_finalize (pgp_error_t *errp, pgp_writer_t writer);
/* openpgp::PacketPile. */