aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2021-11-29 13:31:05 +0100
committerJay Berkenbilt <ejb@ql.org>2021-11-29 13:42:36 +0100
commit720ce9e8f333ba3911fa8003f08fd8813c19181a (patch)
tree158d7a6c4030f5b468c99f39b875cc1aaadd9c4c /include
parentac17308cf6cd6ea51cfbffdc898f0b67c89ae388 (diff)
downloadqpdf-720ce9e8f333ba3911fa8003f08fd8813c19181a.tar.zst
Improve testing and error handling around operating before processing
Diffstat (limited to 'include')
-rw-r--r--include/qpdf/qpdf-c.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/qpdf/qpdf-c.h b/include/qpdf/qpdf-c.h
index cf32976f..886e521f 100644
--- a/include/qpdf/qpdf-c.h
+++ b/include/qpdf/qpdf-c.h
@@ -113,7 +113,9 @@ extern "C" {
char const* qpdf_get_qpdf_version();
/* Returns dynamically allocated qpdf_data pointer; must be freed
- * by calling qpdf_cleanup.
+ * by calling qpdf_cleanup. You must call qpdf_read or one of the
+ * other qpdf_read_* functions before calling any function that
+ * would need to operate on the PDF file.
*/
QPDF_DLL
qpdf_data qpdf_init();