From fc5004a9e14cfd5c462abca0c8af3cab614aa48d Mon Sep 17 00:00:00 2001
From: Neil <nyamatongwe@gmail.com>
Date: Thu, 23 Apr 2026 10:42:27 +1000
Subject: Add error status SC_STATUS_OUTSIDE_DOCUMENT that is set when
 operations are attempted on a position outside the document. Positions are
 checked earlier to prevent actions partly succeeding. This is implemented
 with a new exception type Failure which should be caught by platform layer's
 API handling code to produce a more granular error status.

---
 doc/ScintillaDoc.html     | 10 ++++++++++
 doc/ScintillaHistory.html |  7 +++++++
 2 files changed, 17 insertions(+)

(limited to 'doc')

diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 3189a001a..c21bd2e29 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -958,6 +958,12 @@ struct Sci_TextRangeFull {
           <td>Memory is exhausted</td>
         </tr>
 
+        <tr>
+          <th align="left"><code>SC_STATUS_OUTSIDE_DOCUMENT</code></th>
+          <td>3</td>
+          <td>An operation was attempted on a position that is outside the document</td>
+        </tr>
+
         <tr>
           <th align="left"><code>SC_STATUS_WARN_REGEX</code></th>
           <td>1001</td>
@@ -967,6 +973,10 @@ struct Sci_TextRangeFull {
       </tbody>
     </table>
 
+    <p>To more easily check the status of APIs, applications should call the direct status function using
+    <a class="message" href="#SCI_GETDIRECTSTATUSFUNCTION"><code>SCI_GETDIRECTSTATUSFUNCTION</code></a>.
+    </p>
+
     <h2 id="Selection">Selection</h2>
 
     <p>Scintilla maintains a selection that stretches between two points, the anchor and the
diff --git a/doc/ScintillaHistory.html b/doc/ScintillaHistory.html
index ea660ae37..fdcde25f9 100644
--- a/doc/ScintillaHistory.html
+++ b/doc/ScintillaHistory.html
@@ -606,6 +606,13 @@
 	Released 26 March 2026.
 	</li>
 	<li>
+	Add error status SC_STATUS_OUTSIDE_DOCUMENT that is set when operations are attempted on a position
+	outside the document.
+	Positions are checked earlier to prevent actions partly succeeding.
+	Incomplete actions could lead to features that are out of synchronization
+	like change history referring to text that has been deleted.
+	</li>
+	<li>
 	On Win32 with DirectWrite in a GDI scaled application, draw sharper text in autocompletion lists.
 	<a href="https://sourceforge.net/p/scintilla/bugs/2505/">Bug #2505</a>.
 	</li>
-- 
cgit v1.2.3