010 Editor

https://www.sweetscape.com/010editor/manual/
Admin
010 Editor is a professional text and hex editor with binary templates for analyzing and editing...
Tokens:249,024
Snippets:2,097
Trust Score:9.8
Update:9 months ago
Show doc for...
Tokens:
Raw
### Perform Initial Installation Steps (010 Editor CLI)

Source: https://www.sweetscape.com/010editor/manual/CommandLine

The `-install` command re-runs the initial setup steps for 010 Editor on Linux, macOS, or Windows Portable installations. This includes displaying the EULA, checking system paths, and creating desktop shortcuts/associations, useful if the application's location changes.

```cli
010editor -install
```

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

### Example Syntax Tree Output

Source: https://www.sweetscape.com/010editor/manual/WritingTreesitter

This output represents the syntax tree generated for the example code snippet. It shows the hierarchical structure of the code, with byte addresses indicating the start and end of each element.

```text
Syntax Tree 010:
(source_file [0 35]
  (declaration [0 31]
    type: (struct_specifier [0 25]
      "struct" [0 6]
      body: (compound_statement [7 25]
        "{" [7 8]
        (declaration [13 23]
          type: (primitive_type [13 16])
          declarator: (identifier [17 22])
          ";" [22 23])
        "}" [24 25]))
    declarator: (identifier [26 30])
    ";" [30 31])

```

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

### GetSelStart

Source: https://www.sweetscape.com/010editor/manual/FuncInterface

Returns the starting address of the current selection.

```APIDOC
## GetSelStart

### Description
Returns the start address of the selection in local coordinates. Use GetSelSize to determine if a selection has been made.

### Method
GET

### Endpoint
N/A (Function call within script)

### Parameters
None

### Request Example
```
int64 selectionStart = GetSelStart();
```

### Response
#### Success Response (Return Value)
- **int64** - The starting address of the selection in local coordinates.
```

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

### Make Selections via Command Line (010 Editor)

Source: https://www.sweetscape.com/010editor/manual/CommandLine

Demonstrates creating selections in a file using the '-select:<start>:<size>' command in 010 Editor. Both 'start' and 'size' are in bytes and accept various numeric formats. If 'start' is omitted, selection begins from the current caret position.

```bash
010editor -select:16:4
010editor -select::0x200
```

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

### Padded Bitfield Padding Example

Source: https://www.sweetscape.com/010editor/manual/Bitfields

Shows an example of padded bitfields where padding is automatically added due to type changes or crossing variable boundaries. This ensures bitfields start on appropriate memory alignments.

```c
int   apple   : 10;
int   orange  : 20;
int   banana  : 10;
int   peach   : 12;
short grape   : 4;
```

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

### Printf Function Example

Source: https://www.sweetscape.com/010editor/manual/Functions

Demonstrates the usage of the Printf function with variable arguments to format and display string and length information in the Output tab.

```c
Printf( "string='%s' length='%d'\n", str, Strlen( str ) );
```

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

### Example of Calling a 010 Editor Scripting Function

Source: https://www.sweetscape.com/010editor/manual/Functions

Demonstrates how to call a built-in 010 Editor scripting function, similar to standard C syntax. The example shows calling the 'Strlen' function to get the length of a string variable.

```010 Script
string str = "Apple";
     return Strlen( str ); 

```

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

### Opening Files from Command Line

Source: https://www.sweetscape.com/010editor/manual/CommandLine

Learn how to open one or more files, including using wildcards, directly from the command line when starting 010 Editor.

```APIDOC
## Opening Files

### Description
Specify a set of files to load on the command line when starting 010 Editor. Files are separated by spaces. Wildcards '*' and '?' can be used to load multiple files.

### Method
Command Line Execution

### Endpoint
`010editor [file1] [file2] ...`

### Parameters
#### Path Parameters
- **file1** (string) - Optional - The first file to load.
- **file2** (string) - Optional - Additional files to load, separated by spaces.

#### Query Parameters
None

#### Request Body
None

### Request Example
```
     010editor file1.dat file2.dat
     010editor *.bin file???.dat
```

### Response
#### Success Response (0)
- **Application Window** (object) - The 010 Editor application window with the specified files loaded.

#### Response Example
(No direct response body, the application window opens with loaded files)
```

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

### GetStartingAddress

Source: https://www.sweetscape.com/010editor/manual/FuncInterface

Retrieves the starting address of the file in file coordinates.

```APIDOC
## GetStartingAddress

### Description
Returns the starting address of the file in file coordinates. This is the address of the first byte in the file as displayed in the Hex Editor. Usually the starting address is 0 unless a custom starting address has been assigned to the file. Use SetStartingAddress to modify the starting address.

### Method
GET

### Endpoint
N/A (Function call within script)

### Parameters
None

### Request Example
```
int64 fileStart = GetStartingAddress();
```

### Response
#### Success Response (Return Value)
- **int64** - The starting address of the file in file coordinates.
```

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

### Set File Starting Address

Source: https://www.sweetscape.com/010editor/manual/FuncInterface

Establishes the starting address for the file displayed in the Hex Editor. This address corresponds to the first byte shown. Typically 0 unless a custom address was set. Query with GetStartingAddress. Requires 010 Editor v13.0+.

```010 Script
void SetStartingAddress( int64 address );
```

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

### SetStartingAddress

Source: https://www.sweetscape.com/010editor/manual/FuncInterface

Sets the starting address displayed in the Hex Editor for the current file. Useful for files with custom address offsets.

```APIDOC
## SetStartingAddress

### Description
Sets the starting address of the file to _address_ , which is given in file coordinates. The starting address is the address of the first byte in the file shown in the Hex Editor. The starting address is typically 0 unless a custom starting address was assigned to the file. See the GetStartingAddress function to query the current starting address.

### Method
(Implied function call, no explicit HTTP method)

### Endpoint
N/A (Scripting function)

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

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```
SetStartingAddress(4096);
```

### Response
No explicit return value documented, function returns void.

### Requirements
_Requires 010 Editor v13.0 or higher._
```

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

### WSubStr - Get Substring from Wide String

Source: https://www.sweetscape.com/010editor/manual/FuncString

Returns a wide string containing count characters from str starting at the index start. If count is -1, all characters from start to the end are returned.

```APIDOC
## WSubStr

### Description
Returns a wide string containing _count_ characters from _str_ starting at the index _start_. If _count_ is -1, all the characters from the _start_ index to the end of the string are returned.

### Method
(Not applicable, this is a script function)

### Endpoint
(Not applicable, this is a script function)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
```javascript
// Example usage
string original = "010 Editor Manual";
string sub1 = WSubStr(original, 4, 6); // sub1 is "Editor"
string sub2 = WSubStr(original, 4, -1); // sub2 is "Editor Manual"
```

### Response
#### Success Response (200)
- **Return Value** (wchar_t[]) - The extracted substring.

#### Response Example
(See Request Example)
```

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

### Get Heap Start Address with ProcessGetHeapStartAddress

Source: https://www.sweetscape.com/010editor/manual/FuncInterface

Retrieves the starting memory address for a given heap index. Requires 010 Editor v3.2 or higher. Returns -1 if the file is not a process or the index is invalid.

```010 Script
int64 ProcessGetHeapStartAddress( int index );
```

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

### Get Start Address of a Variable with startof

Source: https://www.sweetscape.com/010editor/manual/Sizeof

The startof keyword returns the starting address of a variable declared in a Template, in local coordinates. This is useful for positioning cursors or accessing data segments.

```010 Script
SetCursorPos( startof( lines[0] ) );
```

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

### Example C Code and its Syntax Tree

Source: https://www.sweetscape.com/010editor/manual/WritingTreesitter

Demonstrates a simple C function and its corresponding syntax tree representation as parsed by Tree-sitter. The syntax tree shows the hierarchical structure of the code, including function definitions, identifiers, and statements.

```c
void main() 
{
    return 5;
}
```

```text
(function_definition
  type: (primitive_type)
  declarator: (function_declarator
    declarator: (identifier)
    parameters: (parameter_list
      "("
      ")"))
  body: (compound_statement
    "{"
    (return_statement
      "return"
      (number_literal)
      ";")
    "}"))
```

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

### Writing Template Syntaxes for 010 Editor

Source: https://www.sweetscape.com/010editor/manual/Project

Provides guidance on how to write custom Binary Templates for 010 Editor. Templates allow for the parsing and visualization of binary data structures.

```plaintext
Writing Templates
```

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

### Get Bookmark Name and Position

Source: https://www.sweetscape.com/010editor/manual/FuncInterface

Retrieves the name and starting address of a bookmark. GetBookmarkName returns the bookmark's name as a string, and GetBookmarkPos returns its starting address as a 64-bit integer. The index parameter must specify a valid bookmark.

```c++
string GetBookmarkName( int index )
int64 GetBookmarkPos( int index )
```

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

### Opening Drives from Command Line

Source: https://www.sweetscape.com/010editor/manual/CommandLine

Details on how to open logical or physical drives using the '-drive:' command line argument.

```APIDOC
## Opening Drives

### Description
Open drives from the command line using the `-drive:` command, followed by a drive label (for logical drives) or a drive number (for physical drives).

### Method
Command Line Execution

### Endpoint
`010editor -drive:[label_or_number] ...`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **-drive:** (string) - Required - Specifies the drive to open. Can be a drive letter (e.g., 'C') for logical drives or a number (e.g., '1') for physical drives.

#### Request Body
None

### Request Example
```
     010editor -drive:C -drive:1 
```
(Opens logical drive C: and physical drive 1)

### Response
#### Success Response (0)
- **Application Window** (object) - The 010 Editor application window with the specified drives opened.

#### Response Example
(No direct response body, the application window opens with loaded drives)
```

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

### Get Template File Offset (C)

Source: https://www.sweetscape.com/010editor/manual/FuncInterface

Returns the current starting offset for a template when processing a file. A value of 0 signifies that no offset has been set. Requires 010 Editor v11.0 or higher.

```c
int64 OffsetGetStart();

```

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

### Example Code for Syntax Tree Generation

Source: https://www.sweetscape.com/010editor/manual/WritingTreesitter

This code snippet demonstrates a simple C-like struct declaration. When processed by Tree-sitter, it generates a syntax tree that can be visualized in 010 Editor.

```c
struct **MYFILE** {
    int value;
}
file;

```

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

### Custom Function Definition and Usage (C)

Source: https://www.sweetscape.com/010editor/manual/Functions

Illustrates how to define a custom function named 'OutputInt' that accepts an integer argument and prints it to the output. It also shows how to call this custom function.

```c
void OutputInt( int d )
{
    Printf( "%d\n", d );
}
OutputInt( 5 );
```

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

### Defining a Basic Enum in 010 Editor

Source: https://www.sweetscape.com/010editor/manual/DataTypes

Provides an example of defining an enumeration 'MYENUM' with default integer values. Constants are assigned values sequentially starting from zero unless explicitly specified.

```010 Script
enum MYENUM { COMP_1, COMP_2 = 5, COMP_3 } var1;

```

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

### Get Local Heap Address with ProcessGetHeapLocalAddress

Source: https://www.sweetscape.com/010editor/manual/FuncInterface

Retrieves the starting local file address for a given memory heap index within a process. Requires 010 Editor v3.2 or higher. Returns -1 if the file is not a process or the index is invalid.

```010 Script
int64 ProcessGetHeapLocalAddress( int index );
```

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

### Open Files via Command Line (010 Editor)

Source: https://www.sweetscape.com/010editor/manual/CommandLine

Demonstrates how to open one or more files using the 010 Editor executable from the command line. Supports wildcards for flexible file selection. Assumes 010 Editor is in the system path.

```bash
010editor file1.dat file2.dat
010editor *.bin file???.dat
```

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

### Find All Occurrences of a String in 010 Editor

Source: https://www.sweetscape.com/010editor/manual/FuncTools

Searches the current file for all occurrences of the ASCII string 'Test'. The function returns a TFindResults structure containing the count of matches and arrays of their starting positions and lengths. This example demonstrates iterating through the results and printing them.

```c
int i;
TFindResults r = FindAll( "Test" );
Printf( "%d\n", r.count );
for( i = 0; i < r.count; i++ )
    Printf( "%Ld %Ld\n", r.start[i], r.size[i] ); 

```

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

### Get Assembly String from File Position

Source: https://www.sweetscape.com/010editor/manual/FuncIO

Reads bytes from a file starting at a given position, converts them into an Opcode, and returns the corresponding assembly language string. Requires disassembly mode to be set. The size of the opcode can be found using DisasmOpSizeFromFile. Compatible with Scripts and Templates.

```010 Editor Script/Template
int64 pos = 10;
string asmString = DisasmOpStringFromFile( pos );
```

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

### Using the Repository in 010 Editor

Source: https://www.sweetscape.com/010editor/manual/Project

Explains how to use the built-in repository feature of 010 Editor for managing and sharing scripts, templates, and other files. It covers installation, updating, and submitting files.

```plaintext
Introduction to the Repository
```

```plaintext
Using the Repository Dialog
```

```plaintext
Installing Files on Open from the Repository
```

```plaintext
Using the Repository Menu
```

```plaintext
Updating and Merging Files
```

```plaintext
Submitting Files to the Repository
```

```plaintext
Updating the Repository
```

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

### Disassemble ARM 32-bit File and Print Results

Source: https://www.sweetscape.com/010editor/manual/DisassemblerTemplates

Demonstrates disassembling an entire ARM 32-bit file using an optimized opcode array and then iterating through the disassembled instructions to print their details (index, start address, size, and string representation) to the Output panel.

```cscript
Opcode ops[FileSize()] <disasm=DISASM_ARM_32>;
local int i, count = DisasmNumOps( ops );
for( i = 0; i < count; i++ )
    Printf( "%d (%d %d)= '%s'\n", 
        i, startof(ops[i]), sizeof(ops[i]), 
        DisasmOpString( ops[i] ) );

```

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

### Convert String to GUID - 010 Editor Scripting

Source: https://www.sweetscape.com/010editor/manual/FuncString

Converts a string formatted as a GUID (e.g., "{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}") into a GUID structure. Returns 0 on success or a negative number if the string cannot be converted. Requires 010 Editor v11.0+.

```010 Script
int StringToGUID( string str, GUID g )
{
    // Converts string str to GUID g
    // Returns 0 on success, negative on failure
    // Requires 010 Editor v11.0+
}
```

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

### Submit Dialog - Add History and Version Information

Source: https://www.sweetscape.com/010editor/manual/RepositorySubmit

Demonstrates how to use the Submit dialog to add version history and author information to a file. This includes specifying the author, changes, and handling initial releases.

```pseudo
SubmitDialog:
  Author: "Your Name/Initials"
  Changes: "Initial release."
  Add Button: Click
```

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

### GUID Data Type in 010 Editor

Source: https://www.sweetscape.com/010editor/manual/DataTypes

Represents a GUID (Globally Unique Identifier) as a 16-byte array, commonly used in Windows. Available since 010 Editor v11. The GUID is displayed in a standard format in Template Results.

```c
// GUID is a built-in typedef for an array of 16 bytes.
// It is used in Microsoft Windows and displayed in the format {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}.
GUID myGuid;
```

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

### Importing Files from Command Line

Source: https://www.sweetscape.com/010editor/manual/CommandLine

How to import files of various formats using the '-import:' command line argument.

```APIDOC
## Importing Files

### Description
Import files of available formats using the `-import:` command, followed by the file to load. The import type is determined by the file extension.

### Method
Command Line Execution

### Endpoint
`010editor -import:[file_path] ...`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **-import:** (string) - Required - The path to the file to import. Wildcard characters '*' and '?' can be used.

#### Request Body
None

### Request Example
```
     010editor -import:array.c
     010editor -import:*.dat
```

### Response
#### Success Response (0)
- **Application Window** (object) - The 010 Editor application window with the imported file(s) loaded and converted.

#### Response Example
(No direct response body, the application window opens with imported files)
```

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

### Using Projects and Workspaces in 010 Editor

Source: https://www.sweetscape.com/010editor/manual/Project

Details how to utilize the Projects and Workspaces feature in 010 Editor for organizing and managing multiple related files for a single task or project.

```plaintext
Using Projects and Workspaces
```

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

### Convert GUID to String - C++

Source: https://www.sweetscape.com/010editor/manual/FuncString

Converts a GUID (Globally Unique Identifier) structure into its standard string representation. Requires 010 Editor v11.0 or higher.

```C++
string GUIDToString( GUID g )
{
     // Example usage:
     GUID myGUID;
     // ... initialize myGUID ...
     return GUIDToString( myGUID );
}
```

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

### WStrDel - Delete Characters from Wide String

Source: https://www.sweetscape.com/010editor/manual/FuncString

Returns a new string where count characters have been removed from the original string str starting at the index start. The original string is not modified.

```APIDOC
## WStrDel

### Description
Returns a string where _count_ characters have been removed from the string _str_ starting at the index _start_. Note that the _str_ argument is not modified.

### Method
(Not applicable, this is a script function)

### Endpoint
(Not applicable, this is a script function)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
```javascript
// Example usage
string original = "010 Editor Manual";
string modified = WStrDel(original, 4, 7); // modified is "010 Manual"
```

### Response
#### Success Response (200)
- **Return Value** (wchar_t[]) - A new string with the specified characters removed.

#### Response Example
(See Request Example)
```

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

### Opening Processes from Command Line

Source: https://www.sweetscape.com/010editor/manual/CommandLine

Instructions for opening processes for editing using the '-process:' command line argument.

```APIDOC
## Opening Processes

### Description
Open processes for editing using the `-process:` command, followed by either a process identification number or the name of a process.

### Method
Command Line Execution

### Endpoint
`010editor -process:[pid_or_name] ...`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **-process:** (string) - Required - Specifies the process to open. Can be a process ID (e.g., '1074') or a process name (e.g., 'cmd.exe').

#### Request Body
None

### Request Example
```
     010editor -process:cmd.exe -process:1074 
```
(Opens the process named 'cmd.exe' and the process with PID 1074)

### Response
#### Success Response (0)
- **Application Window** (object) - The 010 Editor application window with the specified processes opened.

#### Response Example
(No direct response body, the application window opens with loaded processes)
```

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

### Extract Substring

Source: https://www.sweetscape.com/010editor/manual/FuncString

Returns a new string containing a specified number of characters from a source string, starting at a given index. If count is -1, returns characters from the start index to the end.

```010 C
char[] SubStr( const char str[], int start, int count=-1 )
```

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

### Open Drives via Command Line (010 Editor)

Source: https://www.sweetscape.com/010editor/manual/CommandLine

Shows how to open logical or physical drives using the '-drive:' command in 010 Editor. Drive labels open logical drives, while drive numbers open physical drives. Examples include opening drive C: and physical drive 1.

```bash
010editor -drive:C -drive:1
```

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

### Command Line Parameters

Source: https://www.sweetscape.com/010editor/manual/FuncInterface

Details on how to use 010 Editor via command line arguments for automated tasks and scripting.

```APIDOC
## Command Line Parameters

### Description
Provides a list of command-line arguments that can be used to control 010 Editor's behavior and automate tasks.

### Method
Command Line Execution

### Endpoint
N/A (Executed via system command line)

### Parameters
*   **-new** : Opens a new instance of 010 Editor.
*   **-open &lt;filename&gt;** : Opens the specified file.
*   **-script &lt;scriptname&gt; &lt;filename&gt;** : Runs a script on the specified file.
*   **-template &lt;templatename&gt; &lt;filename&gt;** : Applies a template to the specified file.
*   **-compare &lt;file1&gt; &lt;file2&gt;** : Compares two files.
*   **-exit** : Exits 010 Editor.
*   **-batch** : Runs in batch mode (no user interface).

### Request Example
```bash
"C:\Program Files\010 Editor\010Editor.exe" -open "C:\data\mydata.bin"
"C:\Program Files\010 Editor\010Editor.exe" -script "C:\scripts\process.bfs" "C:\data\input.dat"
```

### Response
#### Success Response
Command line operations execute and modify files or application state as specified.

#### Response Example
None
```
Tokens:
Raw