From 74815ce2e9b6458221c7bdf53ec2215c8c7baa4e Mon Sep 17 00:00:00 2001
From: Zufu Liu <unknown>
Date: Sat, 4 May 2019 11:32:21 +1000
Subject: Bug [#2102]. Explain behaviour when length argument longer than
 document.

---
 doc/ScintillaDoc.html | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 8d6d54777..961babc34 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -469,8 +469,9 @@
     </code>
 
     <p><b id="SCI_GETTEXT">SCI_GETTEXT(int length, char *text NUL-terminated) &rarr; int</b><br />
-     This returns <code class="parameter">length</code>-1 characters of text from the start of the document plus one
-    terminating 0 character. To collect all the text in a document, use <code>SCI_GETLENGTH</code>
+     This returns at most <code class="parameter">length</code>-1 characters of text from the start of the document plus one
+    terminating 0 character. When <code class="parameter">length</code>-1 is beyond document length, it returns document length.
+    To collect all the text in a document, use <code>SCI_GETLENGTH</code>
     to get the number of characters in the document (<code>nLen</code>), allocate a character
     buffer of length <code>nLen+1</code> bytes, then call <code>SCI_GETTEXT(nLen+1, char
     *text)</code>. If the text argument is 0 then the length that should be allocated to store the
-- 
cgit v1.2.3