aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/ScintillaDoc.html
diff options
context:
space:
mode:
authorNeil <nyamatongwe@gmail.com>2026-04-23 10:42:27 +1000
committerNeil <nyamatongwe@gmail.com>2026-04-23 10:42:27 +1000
commitfc5004a9e14cfd5c462abca0c8af3cab614aa48d (patch)
tree3ee485eec59e9f1547002a8b862c3d25b2a7e306 /doc/ScintillaDoc.html
parentff16983250f077aa2fa1ac1039ad421813fd20f0 (diff)
downloadscintilla-mirror-fc5004a9e14cfd5c462abca0c8af3cab614aa48d.tar.gz
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.
Diffstat (limited to 'doc/ScintillaDoc.html')
-rw-r--r--doc/ScintillaDoc.html10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 3189a001a..c21bd2e29 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -959,6 +959,12 @@ struct Sci_TextRangeFull {
</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>
<td>Regular expression is invalid</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