diff options
Diffstat (limited to 'openpgp-ffi/include/sequoia/openpgp.h')
| -rw-r--r-- | openpgp-ffi/include/sequoia/openpgp.h | 10 |
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. */ |