Clarify documentation for FPDFLink_GetURL
buflen and the return value represent the number of 16-bit code units,
not the number of characters (which can be up to two 16-bit code units).
PiperOrigin-RevId: 288962917
Change-Id: Idc6d6a812a995c03f36f19888496e08c070a594e
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/64871
Reviewed-by: Lei Zhang <thestig@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>
diff --git a/public/fpdf_text.h b/public/fpdf_text.h
index 3cce6ad..4129282 100644
--- a/public/fpdf_text.h
+++ b/public/fpdf_text.h
@@ -524,16 +524,16 @@
// link_page - Handle returned by FPDFLink_LoadWebLinks.
// link_index - Zero-based index for the link.
// buffer - A unicode buffer for the result.
-// buflen - Number of characters (not bytes) for the buffer,
-// including an additional terminator.
+// buflen - Number of 16-bit code units (not bytes) for the
+// buffer, including an additional terminator.
// Return Value:
-// If |buffer| is NULL or |buflen| is zero, return the number of
-// characters (not bytes) needed to buffer the result (an additional
+// If |buffer| is NULL or |buflen| is zero, return the number of 16-bit
+// code units (not bytes) needed to buffer the result (an additional
// terminator is included in this count).
// Otherwise, copy the result into |buffer|, truncating at |buflen| if
-// the result is too large to fit, and return the number of characters
-// actually copied into the buffer (the additional terminator is also
-// included in this count).
+// the result is too large to fit, and return the number of 16-bit code
+// units actually copied into the buffer (the additional terminator is
+// also included in this count).
// If |link_index| does not correspond to a valid link, then the result
// is an empty string.
//
