Add a clarification comment to FPDF_GetLastError() documentation.
Let the reader know that FPDF_GetLastError() only works with specific
APIs. This is a point of confusion, especially for developers used to
Win32 GetLastError(), which works for many APIs.
Change-Id: I31af3ebebd5aace505e9fb23feef5537a9d83f82
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/94691
Reviewed-by: Tom Sepez <tsepez@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>
Commit-Queue: Tom Sepez <tsepez@chromium.org>
diff --git a/public/fpdfview.h b/public/fpdfview.h
index 8f3bd3c..4ce6f6a 100644
--- a/public/fpdfview.h
+++ b/public/fpdfview.h
@@ -582,7 +582,8 @@
// A 32-bit integer indicating error code as defined above.
// Comments:
// If the previous SDK call succeeded, the return value of this
-// function is not defined.
+// function is not defined. This function only works in conjunction
+// with APIs that mention FPDF_GetLastError() in their documentation.
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_GetLastError();
// Experimental API.
