aboutsummaryrefslogtreecommitdiffstats
path: root/include/qpdf/QPDFWriter.hh
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2019-01-19 21:58:43 +0100
committerJay Berkenbilt <ejb@ql.org>2019-01-19 21:58:51 +0100
commite1271361c59085fc68d75e37faae99f4e595b73e (patch)
tree06a171655e242c1dea00145ab867f2de2b52f1ef /include/qpdf/QPDFWriter.hh
parent0a3057dc0a1b77720cf560a2644ed039dd46bd6a (diff)
downloadqpdf-e1271361c59085fc68d75e37faae99f4e595b73e.tar.zst
Add documentation for features since 8.3.0
Diffstat (limited to 'include/qpdf/QPDFWriter.hh')
-rw-r--r--include/qpdf/QPDFWriter.hh10
1 files changed, 10 insertions, 0 deletions
diff --git a/include/qpdf/QPDFWriter.hh b/include/qpdf/QPDFWriter.hh
index 885a3630..1aa4e8a8 100644
--- a/include/qpdf/QPDFWriter.hh
+++ b/include/qpdf/QPDFWriter.hh
@@ -343,6 +343,16 @@ class QPDFWriter
// setting R4 parameters pushes the version to at least 1.5, or if
// AES is used, 1.6, and setting R5 or R6 parameters pushes the
// version to at least 1.7 with extension level 3.
+ //
+ // Note about Unicode passwords: the PDF specification requires
+ // passwords to be encoded with PDF Doc encoding for R <= 4 and
+ // UTF-8 for R >= 5. In all cases, these methods take strings of
+ // bytes as passwords. It is up to the caller to ensure that
+ // passwords are properly encoded. The qpdf command-line tool
+ // tries to do this, as discussed in the manual. If you are doing
+ // this from your own application, QUtil contains many transcoding
+ // functions that could be useful to you, most notably
+ // utf8_to_pdf_doc.
QPDF_DLL
void setR3EncryptionParameters(
char const* user_password, char const* owner_password,