aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorNeil <nyamatongwe@gmail.com>2024-03-22 17:20:23 +1100
committerNeil <nyamatongwe@gmail.com>2024-03-22 17:20:23 +1100
commitc182518c469fcb28bacf84ec625d5c481a773803 (patch)
tree2813e9925fb5fe47c8bdc22f2a841bd0536c5165
parentd853508df8c3d391ff841aa9ad65670b4e163422 (diff)
downloadscintilla-mirror-c182518c469fcb28bacf84ec625d5c481a773803.tar.gz
Document that failure in SCI_ALLOCATESUBSTYLES returns a negative number.
Possible failures include requesting more substyles than available.
-rw-r--r--doc/ScintillaDoc.html7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index b5ad08649..25dce1dbf 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -129,7 +129,7 @@
<h1>Scintilla Documentation</h1>
- <p>Last edited 16 February 2024 NH</p>
+ <p>Last edited 22 March 2024 NH</p>
<p style="background:#90F0C0">Scintilla 5 has moved the lexers from Scintilla into a new
<a href="Lexilla.html">Lexilla</a> project.<br />
@@ -8598,6 +8598,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
<p><b id="SCI_ALLOCATESUBSTYLES">SCI_ALLOCATESUBSTYLES(int styleBase, int numberStyles) &rarr; int</b><br />
Allocate some number of substyles for a particular base style returning the first substyle number allocated.
+ A failure, such as requesting more substyles than available, is indicated by returning a negative number.
+ Lexers that support substyles will commonly allow allocating 64 substyles.
Substyles are allocated contiguously.</p>
<p><b id="SCI_FREESUBSTYLES">SCI_FREESUBSTYLES</b><br />
@@ -8734,6 +8736,9 @@ needs to be folded as this allowed fixing up the last line from the previous fol
The new approach allows the lexer to decide whether to backtrack or to handle this
more efficiently.</p>
+<p><code>AllocateSubStyles</code> returns a negative number when more
+substyles are requested than is available.</p>
+
<p><code>NamedStyles</code>, <code>NameOfStyle</code>,
<code>TagsOfStyle</code>, and <code>DescriptionOfStyle</code>
are used to provide information on the set of styles used by this lexer.