summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHenrique Nakashima <hnakashima@chromium.org>2017-06-22 16:14:09 -0400
committerChromium commit bot <commit-bot@chromium.org>2017-06-22 20:39:49 +0000
commit10e02fa3acdf8383e627087265ad1235406a1752 (patch)
tree673abcedb59dbf21450cc153ff2c5772e412aeac
parent143959dba65c78f404a5d8984edb5ec5e507325e (diff)
downloadpdfium-10e02fa3acdf8383e627087265ad1235406a1752.tar.xz
Updated FPDF_GetMetaText doc string for linearized files.
Bug: pdfium:664 Change-Id: Iae8dab8c27d087c66b4e883a17e9fe55fe975e30 Reviewed-on: https://pdfium-review.googlesource.com/6836 Reviewed-by: dsinclair <dsinclair@chromium.org> Commit-Queue: dsinclair <dsinclair@chromium.org>
-rw-r--r--public/fpdf_doc.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/public/fpdf_doc.h b/public/fpdf_doc.h
index 8e272238f8..558ea199a9 100644
--- a/public/fpdf_doc.h
+++ b/public/fpdf_doc.h
@@ -296,6 +296,10 @@ DLLEXPORT FPDF_BOOL STDCALL FPDFLink_GetQuadPoints(FPDF_LINK linkAnnot,
// The |buffer| is always encoded in UTF-16LE. The |buffer| is followed by two
// bytes of zeros indicating the end of the string. If |buflen| is less than
// the returned length, or |buffer| is NULL, |buffer| will not be modified.
+//
+// For linearized files, FPDFAvail_IsFormAvail must be called before this, and
+// it must have returned PDF_FORM_AVAIL or PDF_FORM_NOTEXIST. Before that, there
+// is no guarantee the metadata has been loaded.
DLLEXPORT unsigned long STDCALL FPDF_GetMetaText(FPDF_DOCUMENT document,
FPDF_BYTESTRING tag,
void* buffer,