summaryrefslogtreecommitdiff
path: root/public/fpdf_text.h
diff options
context:
space:
mode:
Diffstat (limited to 'public/fpdf_text.h')
-rw-r--r--public/fpdf_text.h24
1 files changed, 14 insertions, 10 deletions
diff --git a/public/fpdf_text.h b/public/fpdf_text.h
index bad66ad085..90ccaf76ae 100644
--- a/public/fpdf_text.h
+++ b/public/fpdf_text.h
@@ -219,14 +219,18 @@ FPDF_EXPORT int FPDF_CALLCONV FPDFText_CountRects(FPDF_TEXTPAGE text_page,
// bottom - Pointer to a double value receiving the rectangle
// bottom boundary.
// Return Value:
-// None.
+// On success, return TRUE and fill in |left|, |top|, |right|, and
+// |bottom|. If |link_page| is invalid then return FALSE, and the out
+// parameters remain unmodified. If |link_page| is valid but
+// |link_index| is out of bounds, then return FALSE and set the out
+// parameters to 0.
//
-FPDF_EXPORT void FPDF_CALLCONV FPDFText_GetRect(FPDF_TEXTPAGE text_page,
- int rect_index,
- double* left,
- double* top,
- double* right,
- double* bottom);
+FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFText_GetRect(FPDF_TEXTPAGE text_page,
+ int rect_index,
+ double* left,
+ double* top,
+ double* right,
+ double* bottom);
// Function: FPDFText_GetBoundedText
// Extract unicode text within a rectangular boundary on the page.
@@ -423,9 +427,9 @@ FPDF_EXPORT int FPDF_CALLCONV FPDFLink_CountRects(FPDF_PAGELINK link_page,
// bottom boundary.
// Return Value:
// On success, return TRUE and fill in |left|, |top|, |right|, and
-// |bottom|. If |link_index| does not correspond to a valid link, then
-// return FALSE, and |left|, |top|, |right|, and |bottom| remain
-// unmodified.
+// |bottom|. If |link_page| is invalid or if |link_index| does not
+// correspond to a valid link, then return FALSE, and the out
+// parameters remain unmodified.
//
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFLink_GetRect(FPDF_PAGELINK link_page,
int link_index,