Scintilla

https://www.scintilla.org/
Admin
Scintilla is a free, lightweight syntax highlighting editing component used as the foundation for...
Tokens:318,208
Snippets:3,283
Trust Score:9.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start Filerx with SciTE Window Handle

Source: https://www.scintilla.org/SciTEDirector.html

Example of how Filerx can start SciTE, passing its window handle and the file to edit.

```bash
SciTE -director.hwnd=937846 c:\os\scite\src\SciTEBase.cxx
```

--------------------------------

### Build File Configuration (Make Example)

Source: https://www.scintilla.org/Scintilla5Migration.html

Example of how to configure build files (like Make) to include necessary header files for lexers and Lexilla, and to add LexillaAccess.cxx to source files.

```makefile
LEXILLA_DIR ?= $(srcdir)/../../lexilla
INCLUDES += -I $(LEXILLA_DIR)/include  -I $(LEXILLA_DIR)/access
SOURCES += $(LEXILLA_DIR)/access/LexillaAccess.cxx
```

--------------------------------

### OnStyle Function Example (Line-Oriented)

Source: https://www.scintilla.org/ScriptLexer.html

An example of a line-oriented lexer using direct calls to Scintilla functions for styling.

```APIDOC
## OnStyle Function Example (Line-Oriented)

### Description
This example demonstrates a line-oriented lexer that styles each line based on its first character, using direct low-level calls instead of the standard StartStyling/More/Forward/EndStyling sequence.

### Function Signature
`function OnStyle(styler)`

### Parameters
- **styler**: The styler object provided by Scintilla.

### Logic
1. Determine the start and end line numbers within the given range.
2. Iterate through each line from `lineStart` to `lineEnd`.
3. For each line, get its length and text content.
4. Determine the style based on the first character of the line:
   - `+`: style 1
   - ` ` or `\t`: style 2
   - Other characters: default style (0)
5. Apply the determined style to the entire line using `editor:SetStyling()`.

### Example Code
```lua
function OnStyle(styler)
  local lineStart = editor:LineFromPosition(styler.startPos)
  local lineEnd = editor:LineFromPosition(styler.startPos + styler.lengthDoc)
  editor:StartStyling(styler.startPos, 31)
  for line=lineStart,lineEnd,1 do
    local lengthLine = editor:PositionFromLine(line+1) - editor:PositionFromLine(line)
    local lineText = editor:GetLine(line)
    local first = string.sub(lineText,1,1)
    local style = 0
    if first == "+" then
      style = 1
    elseif first == " " or first == "\t" then
      style = 2
    end
    editor:SetStyling(lengthLine, style)
  end
end
```
```

--------------------------------

### Set and Get Indentation Guides Visibility

Source: https://www.scintilla.org/ScintillaDoc.html

Controls the display of indentation guides (vertical lines) to help visualize code structure. Accepts an integer value to control the view.

```c
SCI_SETINDENTATIONGUIDES(int indentView)
```

```c
SCI_GETINDENTATIONGUIDES → int
```

--------------------------------

### Indentation Guides

Source: https://www.scintilla.org/ScintillaDoc.html

Configure the display and highlighting of indentation guides.

```APIDOC
## Indentation Guides

### SCI_SETINDENTATIONGUIDES

Sets the display mode for indentation guides. The interpretation of `indentView` depends on the Scintilla version and configuration, but typically controls visibility and style.

**Parameters:**
- `indentView` (int): A value controlling the display of indentation guides.

### SCI_GETINDENTATIONGUIDES

Retrieves the current setting for indentation guide display.

**Returns:**
- int: The current indentation guide display setting.

### SCI_SETHIGHLIGHTGUIDE

Sets a specific column to be highlighted as a guide. This is often used to highlight the current indentation level.

**Parameters:**
- `column` (position): The column number to highlight as a guide.

### SCI_GETHIGHLIGHTGUIDE

Retrieves the column number that is currently highlighted as a guide.

**Returns:**
- position: The column number of the highlighted guide.
```

--------------------------------

### SCI_STARTSTYLING

Source: https://www.scintilla.org/ScintillaDoc.html

Prepares for styling by setting the starting position for subsequent styling operations.

```APIDOC
## SCI_STARTSTYLING

### Description
This prepares for styling by setting the styling position `start` to start at. The unused argument was used in earlier versions but is now ignored. After `SCI_STARTSTYLING`, send multiple `SCI_SETSTYLING` messages for each lexical entity to style or send `SCI_SETSTYLINGEX` to style in blocks.

### Method
POST

### Endpoint
N/A (Message-based API)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **start** (position) - The starting position for styling.
- **unused** (int) - This argument is ignored.
```

--------------------------------

### Selection Start and End Properties

Source: https://www.scintilla.org/ScintillaDoc.html

Allows querying and setting the start and end positions, including virtual space, for each selection.

```APIDOC
## SCI_SETSELECTIONNSTART

### Description
Sets the start position (anchor) for a specific selection.

### Method
SCI_SETSELECTIONNSTART(int selection, position anchor)

### Parameters
- **selection** (int) - The zero-based index of the selection.
- **anchor** (position) - The new start position.

## SCI_GETSELECTIONNSTART

### Description
Retrieves the start position (anchor) of a specific selection.

### Method
SCI_GETSELECTIONNSTART(int selection) → position

### Parameters
- **selection** (int) - The zero-based index of the selection.

### Returns
- **position** - The start position.

## SCI_GETSELECTIONNSTARTVIRTUALSPACE

### Description
Retrieves the amount of virtual space at the start position of a specific selection.

### Method
SCI_GETSELECTIONNSTARTVIRTUALSPACE(int selection) → position

### Parameters
- **selection** (int) - The zero-based index of the selection.

### Returns
- **position** - The amount of virtual space at the start.

## SCI_SETSELECTIONNEND

### Description
Sets the end position (caret) for a specific selection.

### Method
SCI_SETSELECTIONNEND(int selection, position caret)

### Parameters
- **selection** (int) - The zero-based index of the selection.
- **caret** (position) - The new end position.

## SCI_GETSELECTIONNEND

### Description
Retrieves the end position (caret) of a specific selection.

### Method
SCI_GETSELECTIONNEND(int selection) → position

### Parameters
- **selection** (int) - The zero-based index of the selection.

### Returns
- **position** - The end position.

## SCI_GETSELECTIONNENDVIRTUALSPACE

### Description
Retrieves the amount of virtual space at the end position of a specific selection.

### Method
SCI_GETSELECTIONNENDVIRTUALSPACE(int selection) → position

### Parameters
- **selection** (int) - The zero-based index of the selection.

### Returns
- **position** - The amount of virtual space at the end.
```

--------------------------------

### Highlight Indentation Guide

Source: https://www.scintilla.org/ScintillaDoc.html

Sets a specific column to be highlighted by an indentation guide. Useful for drawing attention to a particular indentation level.

```c
SCI_SETHIGHLIGHTGUIDE(position column)
```

```c
SCI_GETHIGHLIGHTGUIDE → position
```

--------------------------------

### Tab and Indentation Properties

Source: https://www.scintilla.org/PaneAPI.html

Properties for configuring tab width, indentation, and indentation guides.

```APIDOC
## Tabs and Indentation Guides
int editor.TabMinimumWidth -- Set the minimum visual width of a tab.
int editor.TabWidth -- Change the visible size of a tab to be a multiple of the width of a space character.
bool editor.UseTabs -- Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.
int editor.Indent -- Set the number of spaces used for one level of indentation.
bool editor.TabIndents -- Sets whether a tab pressed when caret is within indentation indents.
bool editor.BackSpaceUnIndents -- Sets whether a backspace pressed when caret is within indentation unindents.
int editor.IndentationGuides -- Show or hide indentation guides.
position editor.HighlightGuide -- Set the highlighted indentation guide column. 0 = no highlighted guide.
```

--------------------------------

### Qt Example: Create Lexer and Set in Scintilla

Source: https://www.scintilla.org/LexillaDoc.html

Demonstrates how to load a Lexilla shared library and create a lexer instance using Qt's QLibrary. This is useful when integrating Lexilla with Qt applications.

```cpp
#if _WIN32  
    typedef void *(__stdcall *CreateLexerFn)(const char *name);  
#else  
    typedef void *(*CreateLexerFn)(const char *name);  
#endif  
    QLibrary library("lexilla");
    if (!library.load()) {
        // Handle error
    }
    void *(*createLexer)(const char *) = (void *(*)(const char *))library.resolve("CreateLexer");
    if (!createLexer) {
        // Handle error
    }
    void *lexCpp = createLexer("cpp");  
    Call(SCI_SETILEXER, 0, (sptr_t)(void *)lexCpp);  
```

--------------------------------

### Get Selection Start and End

Source: https://www.scintilla.org/ScintillaDoc.html

Returns the smaller (start) and larger (end) of the current position or anchor position, regardless of which is which.

```c
SCI_GETSELECTIONSTART → position
```

```c
SCI_GETSELECTIONEND → position
```

--------------------------------

### SCI_GETLINESELSTARTPOSITION

Source: https://www.scintilla.org/ScintillaDoc.html

Gets the start position of the selection on a given line.

```APIDOC
## SCI_GETLINESELSTARTPOSITION(line line) → position

### Description
Gets the start position of the selection on a given line.

### Method
SCI_GETLINESELSTARTPOSITION

### Parameters
- **line** (line) - The line number.

### Returns
- **position** - The start position of the selection on the specified line.
```

--------------------------------

### Get Word Start Position

Source: https://www.scintilla.org/ScintillaDoc.html

Finds the starting position of a word at or before the given position. If `onlyWordCharacters` is true, it stops at the first non-word character.

```c
SCI_WORDSTARTPOSITION(pos, onlyWordCharacters);
```

--------------------------------

### Example of SetLibraryProperty Usage

Source: https://www.scintilla.org/LexillaDoc.html

Illustrates setting a library property, such as a directory for definitions, before creating a lexer. This is useful for lexer libraries that require external configuration.

```c
SetLibraryProperty("definitions.directory", "/usr/share/xeditor/language-definitions")
```

--------------------------------

### Get Line Selection Positions

Source: https://www.scintilla.org/ScintillaDoc.html

Retrieves the start and end positions of the selection within a specific line.

```c
SCI_GETLINESELSTARTPOSITION(line line) → position
```

```c
SCI_GETLINESELENDPOSITION(line line) → position
```

--------------------------------

### Print API Builder Usage Instructions

Source: https://www.scintilla.org/ApiBuilder.java

Displays command-line usage instructions for the API Builder tool, including available options and arguments.

```java
private static void printUsage()
    {
        System.out.println("\nUsage: ApiBuilder [option] <baseDir | jarFile> <output file>");
        System.out.println("OR");
        System.out.println("Usage: ApiBuilder -s <api filename>");
        System.out.println("Options:");
        System.out.println("\t-a: Appends to existing file");
        System.out.println("\t-j: Processes jar file");
        System.out.println("\t-s: Sorts api file. Removes duplicate entry");
        System.exit(1);
    }
```

--------------------------------

### Configure Go Compile and Run Command

Source: https://www.scintilla.org/SciTEDoc.html

Sets up a 'compile and go' command for Go files with a '.c' extension. It specifies the command to compile the file using g++ and then run it.

```properties
command.go.*.c=$(FileName)
```

```properties
command.go.needs.*.c=g++ $(FileNameExt) -o $(FileName)
```

--------------------------------

### Allocate Extended Styles

Source: https://www.scintilla.org/PaneAPI.html

Use editor:AllocateExtendedStyles(numberStyles) to reserve a range of extended style numbers and get the starting number.

```lua
int editor:AllocateExtendedStyles(int numberStyles)
```

--------------------------------

### SCI_SETMODEVENTMASK / SCI_GETMODEVENTMASK

Source: https://www.scintilla.org/ScintillaDoc.html

These messages set and get an event mask that determines which document change events are notified to the container with SCN_MODIFIED and SCEN_CHANGE. For example, a container may decide to see only notifications about changes to text and not styling changes.

```APIDOC
## SCI_SETMODEVENTMASK / SCI_GETMODEVENTMASK

### Description
Set and get an event mask that determines which document change events are notified to the container with `SCN_MODIFIED` and `SCEN_CHANGE`. For example, a container may decide to see only notifications about changes to text and not styling changes by calling `SCI_SETMODEVENTMASK(SC_MOD_INSERTTEXT|SC_MOD_DELETETEXT)`.

The possible notification types are the same as the `modificationType` bit flags used by `SCN_MODIFIED`: `SC_MOD_INSERTTEXT`, `SC_MOD_DELETETEXT`, `SC_MOD_CHANGESTYLE`, `SC_MOD_CHANGEFOLD`, `SC_PERFORMED_USER`, `SC_PERFORMED_UNDO`, `SC_PERFORMED_REDO`, `SC_MULTISTEPUNDOREDO`, `SC_LASTSTEPINUNDOREDO`, `SC_MOD_CHANGEMARKER`, `SC_MOD_BEFOREINSERT`, `SC_MOD_BEFOREDELETE`, `SC_MULTILINEUNDOREDO`, and `SC_MODEVENTMASKALL`.
```

--------------------------------

### Building Lexilla

Source: https://www.scintilla.org/LexillaDoc.html

Instructions on how to build the Lexilla library from source code.

```APIDOC
## Building Lexilla

### Description
This section provides instructions for building the Lexilla library from source.

### Prerequisites
- Lexilla requires headers from Scintilla.
- A directory named `scintilla` containing Scintilla 5+ must be a peer to the `lexilla` directory.

### Build Instructions

#### Using make (gcc/clang)
1. Navigate to the `lexilla/src` directory.
2. Run the command: `make`

#### Using nmake (MSVC)
1. Navigate to the `lexilla/src` directory.
2. Run the command: `nmake -f lexilla.mak`

### Building and Running Tests

#### Using make (gcc/clang)
1. Navigate to the `lexilla/test` directory.
2. Run the command: `make test`

#### Using nmake (MSVC)
1. Navigate to the `lexilla/test` directory.
2. Run the command: `nmake -f testlexers.mak test`

### Alternative Build Systems
- **Microsoft Visual C++:** Use `src/Lexilla.vcxproj` and `test/TestLexers.vcxproj`.
- **Xcode:** Use `src/Lexilla/Lexilla.xcodeproj`.
- **Scripts:** `scripts/RunTest.sh` (gcc/clang) and `scripts/RunTest.bat` (MSVC) can be used to build Lexilla and run tests.
```

--------------------------------

### Character Set Examples

Source: https://www.scintilla.org/SciTERegEx.html

Illustrates various ways to define character sets for matching. Includes matching specific characters, ranges, and negations.

```regex
[-]|]
```

```regex
[]-|]
```

```regex
[a-z]
```

```regex
[^-]]
```

```regex
[^A-Z]
```

```regex
[a-zA-Z]
```

--------------------------------

### SCI_BRACEMATCHNEXT

Source: https://www.scintilla.org/ScintillaDoc.html

Similar to SCI_BRACEMATCH, but the matching search starts at an explicit start position.

```APIDOC
## SCI_BRACEMATCHNEXT position pos, position startPos → position

### Description
Finds the position of a corresponding matching brace, similar to `SCI_BRACEMATCH`, but the search begins at an explicitly provided starting position.

### Method
SCI_BRACEMATCHNEXT

### Parameters
- **pos** (position) - The position of one brace.
- **startPos** (position) - The explicit position from which to start the matching search.

### Returns
- **position** - The position of the matching brace, or -1 if no match is found or the character at `pos` is not a brace.

### Notes
- This function behaves identically to `SCI_BRACEMATCH` except for the starting point of the search.
```

--------------------------------

### Property Access Example

Source: https://www.scintilla.org/SciTELua.html

Demonstrates how to read, write, and unset properties using Lua table-access semantics with the 'props' pseudo-table.

```lua
props["property.name"]
```

--------------------------------

### Build Method List and Write to File

Source: https://www.scintilla.org/ApiBuilder.java

Builds sorted lists of methods and constructors from a base directory and writes them to a specified output file. Supports appending to existing files.

```java
private void writeToFile(String baseDir, String outputFile)
        throws Exception
    {
        RandomAccessFile output = new RandomAccessFile(outputFile, "rw");

        if (appendToFile)
            output.seek(output.length());

        PrintWriter bw = new PrintWriter(new FileWriter(output.getFD()));
        List methodList = buildMethodList(baseDir);
        List constructorList = buildConstructorList(baseDir);
        List all = new ArrayList();

        all.addAll(methodList);
        all.addAll(constructorList);

        Collections.sort(all, new CaseCompareator());

        for (int j = 0; j < all.size(); j++)
        {
            bw.println((String) all.get(j));
            bw.flush();
        }

        bw.close();
    }
```

--------------------------------

### Import Properties from a File

Source: https://www.scintilla.org/SciTEDoc.html

Imports properties from a specified .properties file and opens an HTML document. The path to the properties file should be accurate.

```bash
SciTE "-import c:\\os\\web_work" SciTEDoc.html
```

--------------------------------

### Run Lexilla Test Suite with NMake

Source: https://www.scintilla.org/LexillaDoc.html

Command to build and run the Lexilla test suite using nmake with the provided makefile, intended for MSVC compilers.

```bash
nmake -f testlexers.mak test
```

--------------------------------

### Get Character at Position

Source: https://www.scintilla.org/PaneAPI.html

Access the editor.CharAt[pos] property (read-only) to get the integer value of the character at a specific position.

```lua
int editor.CharAt[position pos] read-only
```

--------------------------------

### Open HTML File and Go to Line

Source: https://www.scintilla.org/SciTEDoc.html

Opens an HTML file and navigates to a specific line number. Ensure the file path and line number are correct.

```bash
SciTE "-open:C:\\Program Files\\SciTE\\SciTEDoc.html" -goto:123
```

--------------------------------

### Get Character Style at Position

Source: https://www.scintilla.org/PaneAPI.html

Access the editor.StyleAt[pos] property (read-only) to get the style byte of the character at a specific position.

```lua
int editor.StyleAt[position pos] read-only
```

--------------------------------

### Find Indicator Start

Source: https://www.scintilla.org/ScintillaDoc.html

Finds the starting position of a continuous range marked by a specific indicator at or after a given position. Returns -1 if not found.

```c
SCI_INDICATORSTART(int indicator, position pos) → position
```

--------------------------------

### Attaching DirectorExtension in Windows

Source: https://www.scintilla.org/SciTEExtension.html

Example of how to attach a DirectorExtension in a Windows environment. This involves creating an instance of the extension and passing a pointer to it to the SciTEWin constructor.

```cpp
DirectorExtension director;
Extension *extender = &director;
//...
SciTEWin MainWind(extender);
```

--------------------------------

### Get Target as UTF8

Source: https://www.scintilla.org/PaneAPI.html

Use editor:TargetAsUTF8() to get the current target range as a UTF8 encoded string. Returns the length in bytes.

```lua
string editor:TargetAsUTF8()
```

--------------------------------

### Open File with Specific Font and Load Recent Files

Source: https://www.scintilla.org/SciTEDoc.html

Starts SciTE, opens a specified file, loads the recent file list, and sets the base font. Ensure the font name and size are correctly specified.

```bash
SciTE "-font.base=font:MS Gothic,size:11" -save.recent ScintillaGTK.cxx
```

--------------------------------

### Prompt for Parameters Before Execution

Source: https://www.scintilla.org/SciTEDoc.html

Prefixing a command string with '*' will display the Parameters dialog to prompt the user for input before executing the command. The '*' itself is not part of the executed command.

```properties
command.name.1.*.cc=Run My Command
command.1.*.cc=*echo "Enter parameter:" && read param && echo "You entered: $param"
```

--------------------------------

### Example Test Failure Output

Source: https://www.scintilla.org/LexillaDoc.html

An example of a diagnostic message shown when a test case fails, indicating a difference between the actual and expected results for a specific file.

```text
C:\u\hg\lexilla\test\examples\python\x.py:1: is different
```

--------------------------------

### Line-Oriented Lexer Example

Source: https://www.scintilla.org/ScriptLexer.html

This Lua code demonstrates a line-oriented lexer for configuration files. It styles each line based on its first character using direct editor calls instead of the standard StartStyling/More/Forward/EndStyling sequence.

```lua
-- A line oriented lexer - style the line according to the first character  
function OnStyle(styler)  
local lineStart = editor:LineFromPosition(styler.startPos)  
local lineEnd = editor:LineFromPosition(styler.startPos + styler.lengthDoc)  
editor:StartStyling(styler.startPos, 31)  
for line=lineStart,lineEnd,1 do  
local lengthLine = editor:PositionFromLine(line+1) - editor:PositionFromLine(line)  
local lineText = editor:GetLine(line)  
local first = string.sub(lineText,1,1)  
local style = 0  
if first == "+" then  
style = 1  
elseif first == " " or first == "\t" then  
style = 2  
end  
editor:SetStyling(lengthLine, style)  
end  
end  
```

--------------------------------

### Build File List Recursively

Source: https://www.scintilla.org/ApiBuilder.java

Recursively builds a list of '.class' files starting from a given base directory. Prints usage if no '.class' files are found.

```java
private void buildFileList(File baseDir)
    {
        String files[] = baseDir.list();

        if(files == null || files.length == 0)
        {
            System.out.println("\nUnable to find .class files in " + baseDir);
            printUsage();
        }

        for (int i = 0; i < files.length; i++)
        {
            File f = new File(baseDir, files[i]);

            if (f.isDirectory())
                buildFileList(f);
            if (f.getName().endsWith(".class"))
                if (!fileList.contains(f))
                    fileList.add(f);
        }
    }
```

--------------------------------

### C++ Class with Mixed-Case Naming Conventions

Source: https://www.scintilla.org/SciCoding.html

Demonstrates Scintilla's naming conventions for classes, methods, and variables. Class names start with uppercase, while variables start with lowercase. Global scope functions are prefixed with '::'.

```cpp
class
StorageZone
{
public
:
void
Store
(
const
char
*
s
)
{
Media
*
mediaStore
=
::
GetBaseMedia
(
zoneDefault
);
for
(
int
i
=
mediaStore
->
cursor
;
mediaStore
[
i
],
i
++
)
{
mediaStore
->
Persist
(
s
[
i
]
);
}
}
};

```

--------------------------------

### SCI_GETLINESELENDPOSITION

Source: https://www.scintilla.org/ScintillaDoc.html

Gets the end position of the selection on a given line.

```APIDOC
## SCI_GETLINESELENDPOSITION(line line) → position

### Description
Gets the end position of the selection on a given line.

### Method
SCI_GETLINESELENDPOSITION

### Parameters
- **line** (line) - The line number.

### Returns
- **position** - The end position of the selection on the specified line.
```

--------------------------------

### Run Lexilla Test Suite with Make

Source: https://www.scintilla.org/LexillaDoc.html

Command to build and run the Lexilla test suite using make, typically for GCC or Clang compilers.

```bash
make test
```

--------------------------------

### Get Anchor Position

Source: https://www.scintilla.org/ScintillaDoc.html

Retrieves the current anchor position.

```c
SCI_GETANCHOR → position
```

--------------------------------

### Get Current Position

Source: https://www.scintilla.org/ScintillaDoc.html

Retrieves the current caret position.

```c
SCI_GETCURRENTPOS → position
```

--------------------------------

### Open a Text File

Source: https://www.scintilla.org/SciTEDoc.html

Opens a specified text file in SciTE. This is a basic command for loading a file.

```bash
SciTE -open:/big/icon.txt
```

--------------------------------

### Position Adjustment

Source: https://www.scintilla.org/ScintillaDoc.html

Get the position immediately before or after a given position.

```APIDOC
## SCI_POSITIONBEFORE

### Description
Returns the position before another position in the document taking into account the current code page. The minimum position returned is 0 and the maximum is the last position in the document. If called with a position within a multi byte character will return the position of the start of that character.

### Method
SCI_POSITIONBEFORE

### Parameters
- **pos** (position) - The reference document position.

### Response
- **position** (int) - The position before the reference position.
```

```APIDOC
## SCI_POSITIONAFTER

### Description
Returns the position after another position in the document taking into account the current code page. The minimum position returned is 0 and the maximum is the last position in the document. If called with a position within a multi byte character will return the position of the end of that character.

### Method
SCI_POSITIONAFTER

### Parameters
- **pos** (position) - The reference document position.

### Response
- **position** (int) - The position after the reference position.
```

--------------------------------

### Create New Document

Source: https://www.scintilla.org/ScintillaDoc.html

Creates a new, empty document with a reference count of 1. The `bytes` argument pre-allocates memory for efficiency. The `documentOptions` parameter allows customization of document capabilities, such as disabling styles or supporting large documents.

```c
SCI_CREATEDOCUMENT(position bytes, int documentOptions) → pointer
```

--------------------------------

### SCI_AUTOCGETOPTIONS

Source: https://www.scintilla.org/ScintillaDoc.html

Gets the current bitmask of options set for the autocompletion feature.

```APIDOC
## SCI_AUTOCGETOPTIONS

### Description
Gets the current bitmask of options set for the autocompletion feature.

### Method
SCI_AUTOCGETOPTIONS

### Parameters
None

### Response
#### Success Response (200)
- **return value** (int) - The current bitmask of autocompletion options.
```

--------------------------------

### SCI_AUTOCGETORDER

Source: https://www.scintilla.org/ScintillaDoc.html

Gets the current setting for the sorting order of the autocompletion list.

```APIDOC
## SCI_AUTOCGETORDER

### Description
Gets the current setting for the sorting order of the autocompletion list.

### Method
SCI_AUTOCGETORDER

### Parameters
None

### Response
#### Success Response (200)
- **return value** (int) - The current sorting order (`SC_ORDER_PRESORTED` (0), `SC_ORDER_PERFORMSORT` (1), or `SC_ORDER_CUSTOM` (2)).
```

--------------------------------

### Create Scintilla Document

Source: https://www.scintilla.org/Steps.html

Example of sending a specific command (SCI_CREATEDOCUMENT) to the Scintilla control to create a new document. Parameters wparam and lparam are set to 0 as they are unused for this command.

```c++
SendMessage(hwndScintilla,SCI_CREATEDOCUMENT, 0, 0);
```

--------------------------------

### SCI_AUTOCGETMULTI

Source: https://www.scintilla.org/ScintillaDoc.html

Gets the current setting for how autocompletion behaves with multiple selections.

```APIDOC
## SCI_AUTOCGETMULTI

### Description
Gets the current setting for how autocompletion behaves with multiple selections.

### Method
SCI_AUTOCGETMULTI

### Parameters
None

### Response
#### Success Response (200)
- **return value** (int) - The current multiple selection behavior (`SC_MULTIAUTOC_ONCE` (0) or `SC_MULTIAUTOC_EACH` (1)).
```
Tokens:
Raw