Commit 9ad6cfd45bbd84d85509327447bee6e9dcaa56c5
1 parent
ad2c2b84
Clarify qpdf_register_progress_reporter's comment
Showing
1 changed file
with
5 additions
and
1 deletions
include/qpdf/qpdf-c.h
| @@ -471,7 +471,11 @@ extern "C" { | @@ -471,7 +471,11 @@ extern "C" { | ||
| 471 | * a value between 0 and 100 representing the approximate write | 471 | * a value between 0 and 100 representing the approximate write |
| 472 | * progress. The data object you pass to | 472 | * progress. The data object you pass to |
| 473 | * qpdf_register_progress_reporter will be handed back to your | 473 | * qpdf_register_progress_reporter will be handed back to your |
| 474 | - * function. | 474 | + * function. This function must be called after qpdf_init_write |
| 475 | + * (or qpdf_init_write_memory) and before qpdf_write. The | ||
| 476 | + * registered progress reporter applies only to a single write, so | ||
| 477 | + * you must call it again if you perform a subsequent write with a | ||
| 478 | + * new writer. | ||
| 475 | */ | 479 | */ |
| 476 | QPDF_DLL | 480 | QPDF_DLL |
| 477 | void qpdf_register_progress_reporter( | 481 | void qpdf_register_progress_reporter( |