summaryrefslogtreecommitdiff
path: root/public/fpdf_attachment.h
diff options
context:
space:
mode:
authorLei Zhang <thestig@chromium.org>2017-09-22 16:43:01 -0700
committerChromium commit bot <commit-bot@chromium.org>2017-09-25 20:38:41 +0000
commitba14c0a5f12b98c5eaed984f048def6262bab23f (patch)
tree68a700ee69c6d64c699f0faee687e1a0ff6cc2cb /public/fpdf_attachment.h
parent95ec3976ab6cdb22cc6d63c6eeaec9536ae61284 (diff)
downloadpdfium-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_attachment.h')
-rw-r--r--public/fpdf_attachment.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/public/fpdf_attachment.h b/public/fpdf_attachment.h
index 411ee219af..7b55974800 100644
--- a/public/fpdf_attachment.h
+++ b/public/fpdf_attachment.h
@@ -77,7 +77,7 @@ FPDFAttachment_GetName(FPDF_ATTACHMENT attachment,
// Check if the params dictionary of |attachment| has |key| as a key.
//
// attachment - handle to an attachment.
-// 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
@@ -88,7 +88,7 @@ FPDFAttachment_HasKey(FPDF_ATTACHMENT attachment, FPDF_BYTESTRING key);
// the embedded |attachment|.
//
// attachment - handle to an attachment.
-// 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
@@ -100,7 +100,7 @@ FPDFAttachment_GetValueType(FPDF_ATTACHMENT attachment, FPDF_BYTESTRING key);
// type should be FPDF_OBJECT_STRING after this function call succeeds.
//
// attachment - handle to an attachment.
-// key - the key to the dictionary entry, encoded in UTF16-LE.
+// key - the key to the dictionary entry, encoded in UTF-8.
// value - the string value to be set, encoded in UTF16-LE.
//
// Returns true if successful.
@@ -120,7 +120,7 @@ FPDFAttachment_SetStringValue(FPDF_ATTACHMENT attachment,
// and the return value would be 0.
//
// attachment - handle to an attachment.
-// key - the key to the requested string value.
+// key - the key to the requested string value, encoded in UTF-8.
// buffer - buffer for holding the string value encoded in UTF16-LE.
// buflen - length of the buffer.
//