diff options
| author | Lei Zhang <thestig@chromium.org> | 2017-09-22 16:43:01 -0700 |
|---|---|---|
| committer | Chromium commit bot <commit-bot@chromium.org> | 2017-09-25 20:38:41 +0000 |
| commit | ba14c0a5f12b98c5eaed984f048def6262bab23f (patch) | |
| tree | 68a700ee69c6d64c699f0faee687e1a0ff6cc2cb /public/fpdf_annot.h | |
| parent | 95ec3976ab6cdb22cc6d63c6eeaec9536ae61284 (diff) | |
| download | pdfium-ba14c0a5f12b98c5eaed984f048def6262bab23f.tar.xz | |
Update comments regarding dictionary keys in public APIS.chromium/3224
Change-Id: I6420fb5a92c4121d68e9db91c822ea53655ae605
Reviewed-on: https://pdfium-review.googlesource.com/14730
Reviewed-by: dsinclair <dsinclair@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>
Diffstat (limited to 'public/fpdf_annot.h')
| -rw-r--r-- | public/fpdf_annot.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/public/fpdf_annot.h b/public/fpdf_annot.h index b92763855b..1fbc366872 100644 --- a/public/fpdf_annot.h +++ b/public/fpdf_annot.h @@ -343,7 +343,7 @@ FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFAnnot_GetRect(FPDF_ANNOTATION annot, // Check if |annot|'s dictionary has |key| as a key. // // annot - handle to an annotation. -// key - the key to look for. +// key - the key to look for, encoded in UTF-8. // // Returns true if |key| exists. FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFAnnot_HasKey(FPDF_ANNOTATION annot, @@ -353,7 +353,7 @@ FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFAnnot_HasKey(FPDF_ANNOTATION annot, // Get the type of the value corresponding to |key| in |annot|'s dictionary. // // annot - handle to an annotation. -// key - the key to look for. +// key - the key to look for, encoded in UTF-8. // // Returns the type of the dictionary value. FPDF_EXPORT FPDF_OBJECT_TYPE FPDF_CALLCONV @@ -365,7 +365,7 @@ FPDFAnnot_GetValueType(FPDF_ANNOTATION annot, FPDF_BYTESTRING key); // FPDF_OBJECT_STRING after this function call succeeds. // // annot - handle to an annotation. -// key - the key to the dictionary entry to be set, encoded in UTF16-LE. +// key - the key to the dictionary entry to be set, encoded in UTF-8. // value - the string value to be set, encoded in UTF16-LE. // // Returns true if successful. @@ -384,7 +384,7 @@ FPDFAnnot_SetStringValue(FPDF_ANNOTATION annot, // be added to |buffer| and the return value would be 0. // // annot - handle to an annotation. -// key - the key to the requested dictionary entry. +// key - the key to the requested dictionary entry, encoded in UTF-8. // buffer - buffer for holding the value string, encoded in UTF16-LE. // buflen - length of the buffer. // @@ -402,7 +402,7 @@ FPDFAnnot_GetStringValue(FPDF_ANNOTATION annot, // longer needed. // // annot - handle to an annotation. -// key - the key to the requested dictionary entry. +// key - the key to the requested dictionary entry, encoded in UTF-8. // // Returns a handle to the linked annotation object, or NULL on failure. FPDF_EXPORT FPDF_ANNOTATION FPDF_CALLCONV |