diff options
author | Jay Berkenbilt <ejb@ql.org> | 2021-01-19 14:54:47 +0100 |
---|---|---|
committer | Jay Berkenbilt <ejb@ql.org> | 2021-01-19 14:55:23 +0100 |
commit | 9ad6cfd45bbd84d85509327447bee6e9dcaa56c5 (patch) | |
tree | e5595dde3e113305863c8e97076dcbc82bdff10e /include/qpdf/qpdf-c.h | |
parent | ad2c2b8452d5e0a11de214db0410433cc59e1c89 (diff) | |
download | qpdf-9ad6cfd45bbd84d85509327447bee6e9dcaa56c5.tar.zst |
Clarify qpdf_register_progress_reporter's comment
Diffstat (limited to 'include/qpdf/qpdf-c.h')
-rw-r--r-- | include/qpdf/qpdf-c.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/include/qpdf/qpdf-c.h b/include/qpdf/qpdf-c.h index 4127ef39..e917e90a 100644 --- a/include/qpdf/qpdf-c.h +++ b/include/qpdf/qpdf-c.h @@ -471,7 +471,11 @@ extern "C" { * a value between 0 and 100 representing the approximate write * progress. The data object you pass to * qpdf_register_progress_reporter will be handed back to your - * function. + * function. This function must be called after qpdf_init_write + * (or qpdf_init_write_memory) and before qpdf_write. The + * registered progress reporter applies only to a single write, so + * you must call it again if you perform a subsequent write with a + * new writer. */ QPDF_DLL void qpdf_register_progress_reporter( |