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>
diff --git a/public/fpdf_doc.h b/public/fpdf_doc.h
index 8e27223..558ea19 100644
--- a/public/fpdf_doc.h
+++ b/public/fpdf_doc.h
@@ -296,6 +296,10 @@
// 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,
