x64dbg

https://help.x64dbg.com/en/latest
Admin
x64dbg is a free open-source debugger for Windows supporting 32-bit and 64-bit binaries with...
Tokens:135,306
Snippets:1,827
Trust Score:9.8
Update:1 day ago
Show doc for...
Tokens:
Raw
### Example: Get page base and size of selected instruction

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgMemGetPageSize.html

Shows how to use GuiSelectionGet and DbgMemGetPageSize to get the page size of the selected memory address, and DbgMemFindBaseAddr to get the base address and page size in one call.

```cpp
    SELECTIONDATA sel; // Define Address the slected line in the Disassembly window ( begin , End )
    GuiSelectionGet(GUI_DISASSEMBLY, &sel); // Get the value of sel(begin addr , End addr )
    duint pagesize = DbgMemGetPageSize(sel.start);  // get the page size of the section from the selected memory addr
    //Or use the following statement to get page base and size in one call.
    duint sctionbase = DbgMemFindBaseAddr(sel.start, &pagesize); // get the base of this section ( begin addr of the section )
```

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

### Example usage: GuiSelectionGet with GUI_DISASSEMBLY

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiSelectionGet.html

Shows how to call GuiSelectionGet with GUI_DISASSEMBLY and format the resulting start and end addresses using sprintf.

```cpp
SELECTIONDATA sel;
GuiSelectionGet(GUI_DISASSEMBLY, &sel)
sprintf(msg, "%p - %p", sel.start, sel.end);
```

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

### Example usage

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiGetWindowHandle.html

Example of calling GuiGetWindowHandle and storing the result in an HWND variable.

```cpp
HWND hWnd = GuiGetWindowHandle();
```

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

### Example call: GuiReferenceSetSearchStartCol(1)

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiReferenceSetSearchStartCol.html

Sets the search starting column to column 1 (0-based) in the current Reference View instance.

```c
GuiReferenceSetSearchStartCol(1);
```

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

### Example call: GuiUpdateRegisterView();

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateRegisterView.html

An example invocation of GuiUpdateRegisterView to refresh the registers view.

```cpp
GuiUpdateRegisterView();
```

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

### GuiSelectionSet usage example

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiSelectionSet.html

Example showing how to expand the current selection in the disassembly view by 4 bytes and then set it using GuiSelectionSet. The example first retrieves the current selection with GuiSelectionGet.

```c
SELECTIONDATA sel;
GuiSelectionGet(GUI_DISASSEMBLY, &sel)
sel.end += 4; //expand selection
GuiSelectionSet(GUI_DISASSEMBLY, &sel)
```

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

### Example call to GuiUpdateSideBar

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateSideBar.html

Example invocation of GuiUpdateSideBar to refresh the Sidebar.

```c
GuiUpdateSideBar();
```

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

### BridgeFree usage example

Source: https://help.x64dbg.com/en/latest/developers/functions/bridge/BridgeFree.html

Example showing how to allocate memory with BridgeAlloc, use it, and then free it with BridgeFree.

```cpp
auto ptr = (char*)BridgeAlloc(128);
//do something with ptr
BridgeFree(ptr);
```

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

### Example call: GuiUpdateMemoryView();

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateMemoryView.html

Calls the GuiUpdateMemoryView function to refresh the memory view. This example is provided in the documentation's Example section.

```cpp
GuiUpdateMemoryView();
```

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

### Example call: GuiUpdateDumpView()

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateDumpView.html

Calls GuiUpdateDumpView to refresh the dump views. This example shows the function being invoked without arguments.

```c
GuiUpdateDumpView();
```

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

### GuiFocusView example call

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiFocusView.html

Example call to focus on the disassembly tab using the GUI_DISASSEMBLY constant.

```c
GuiFocusView(GUI_DISASSEMBLY); // focus on the disassembly tab.
```

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

### DbgCmdExec usage example

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgCmdExec.html

Example call to DbgCmdExec with the command "run".

```cpp
DbgCmdExec("run");
```

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

### Example call: GuiSymbolSetProgress(50)

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiSymbolSetProgress.html

Sets the progress bar to 50 percent.

```c
GuiSymbolSetProgress(50);
```

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

### Example usage of GuiReferenceSetProgress

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiReferenceSetProgress.html

Shows how to update the progress bar during an operation, with calls at 0%, 50%, and 100% to indicate start, progress, and completion.

```c
GuiReferenceSetProgress(0);
// do something
GuiReferenceSetProgress(50);
// do something else
GuiReferenceSetProgress(100);
// tell user operation has ended
```

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

### Example usage of GuiMenuClear

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiMenuClear.html

Shows how to add a new menu and then clear it. Note that the example uses hMenuNew in the call, which may be a typo for hNewMenu.

```c
hNewMenu = GuiMenuAdd(hMenu, &szMenuTitle);
GuiMenuClear(hMenuNew);
```

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

### Example usage of GuiGetDebuggeeNotes

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiGetDebuggeeNotes.html

Example showing how to call GuiGetDebuggeeNotes, check the returned pointer, and free the buffer with BridgeFree.

```c
char* text = nullptr;
GuiGetDebuggeeNotes(&text);
if(text)
{
    // do something with text
    BridgeFree(text);
}
```

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

### Example usage

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiReferenceSetCurrentTaskProgress.html

Shows how to update progress and status text during an operation, from 0 to 100 percent.

```c
GuiReferenceSetCurrentTaskProgress(0,"Starting Search, Please Wait...");
// do something
GuiReferenceSetCurrentTaskProgress(50,"Searching, Please Wait...");
// do something else
GuiReferenceSetCurrentTaskProgress(100,"Finished Searching.");
// finished
```

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

### BridgeGetDbgVersion usage example

Source: https://help.x64dbg.com/en/latest/developers/functions/bridge/BridgeGetDbgVersion.html

Example of calling BridgeGetDbgVersion and storing the returned version integer in a variable.

```c
int version = BridgeGetDbgVersion();
```

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

### Example: reading selected data from disassembly window

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgMemRead.html

Shows how to use DbgMemRead to read the selected data from the disassembly window. It gets the selection, allocates a buffer, and reads the memory. On success, the selected data is stored in dest.

```cpp
// read user selected data from disassembly window
SELECTIONDATA sel;
GuiSelectionGet(GUI_DISASSEMBLY, &sel);
uint16_t size = sel.end - sel.start + 1;
uint8_t* dest = new uint8_t[size];
bool success = DbgMemRead(sel.start, dest, size);
// on success, the selected data is stored in dest
```

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

### Example call to GuiSymbolRefreshCurrent

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiSymbolRefreshCurrent.html

Example invocation of GuiSymbolRefreshCurrent to refresh the symbol view list.

```cpp
GuiSymbolRefreshCurrent();
```

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

### Example call to GuiUpdateWatchView

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateWatchView.html

Calls GuiUpdateWatchView to refresh the watchdog view. No arguments are passed.

```c
GuiUpdateWatchView();
```

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

### Example: Setting Reference View cell content with GuiReferenceSetCellContent

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiReferenceSetCellContent.html

Shows how to initialize the Reference View, add columns, set row count, and set cell contents for multiple rows. The example uses variables like szCodeCaveStartAddress and szCodeCaveFinishAddress that are assumed to be defined elsewhere. It demonstrates incrementing the row counter after setting all columns for a row.

```c
const char szRefStart = "Start";
const char szRefFinish = "Finish";
const char szRefType = "Type";
GuiReferenceInitialize("Some Information"); // Add Reference View Header Title
GuiReferenceAddColumn(2 * sizeof(DWORD),&szRefStart);  // Add column Name
GuiReferenceAddColumn(2 * sizeof(DWORD),&szRefFinish); // Add column Name
GuiReferenceAddColumn(8,&szRefType); // Add column Name
GuiReferenceSetRowCount(2); // add 2 rows
int iRow = 0;
GuiReferenceSetCellContent(iRow,0,&szCodeCaveStartAddress); // add start address
GuiReferenceSetCellContent(iRow,1,&szCodeCaveFinishAddress); // add finish address
GuiReferenceSetCellContent(iRow,2,&szNop); // add type
iRow = iRow + 1; // Increment rows
// get variables to convert to strings (szCodeCaveStartAddress, szCodeCaveFinishAddress etc)
// add to next row's columns
```

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

### Example usage of GuiSymbolUpdateModuleList

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiSymbolUpdateModuleList.html

Example showing how to build a vector of SYMBOLMODULEINFO, allocate a bridge buffer, copy the data, and call GuiSymbolUpdateModuleList to update the GUI. If SymGetModuleList fails, it calls with null and returns.

```cpp
// Build the vector of modules
std::vector<SYMBOLMODULEINFO> modList;

if(!SymGetModuleList(&modList))
{
    GuiSymbolUpdateModuleList(0, nullptr);
    return;
}

// Create a new array to be sent to the GUI thread
size_t moduleCount = modList.size();
SYMBOLMODULEINFO* data = (SYMBOLMODULEINFO*)BridgeAlloc(moduleCount * sizeof(SYMBOLMODULEINFO));

// Direct copy from std::vector data
memcpy(data, modList.data(), moduleCount * sizeof(SYMBOLMODULEINFO));

// Send the module data to the GUI for updating
GuiSymbolUpdateModuleList((int)moduleCount, data);
```

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

### Example call: GuiScriptSetTitle("Window Title")

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiScriptSetTitle.html

Example usage of GuiScriptSetTitle, setting the script view window title to "Window Title".

```c
GuiScriptSetTitle("Window Title");
```

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

### Example call: GuiUpdateBreakpointsView();

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateBreakpointsView.html

Calls GuiUpdateBreakpointsView to refresh the breakpoints view. No parameters or return value.

```cpp
GuiUpdateBreakpointsView();
```

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

### GuiMenuAdd usage example

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiMenuAdd.html

Example call to GuiMenuAdd, assigning the returned menu handle to hNewMenu.

```c
hNewMenu = GuiMenuAdd(hMenu, &szMenuTitle);
```

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

### Example usage of GuiSetGlobalNotes

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiSetGlobalNotes.html

Example code that reads notes from a file and sets them as global notes using GuiSetGlobalNotes. It checks if the file exists and reads it, then calls the function.

```cpp
notesFile = String(szProgramDir) + "\\notes.txt";
String text;
if(!FileExists(notesFile.c_str()) || FileHelper::ReadAllText(notesFile, text))
    GuiSetGlobalNotes(text.c_str());
```

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

### Example usage: GuiShowCpu();

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiShowCpu.html

Calls the GuiShowCpu function to switch the GUI focus to the CPU tab.

```cpp
GuiShowCpu();
```

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

### Example call: GuiReferenceAddColumn(8,&sztitle)

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiReferenceAddColumn.html

Example invocation of GuiReferenceAddColumn with a width of 8 and a title variable sztitle. The title is passed by address.

```c
GuiReferenceAddColumn(8,&sztitle);
```

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

### Example: DbgCmdExecDirect("run")

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgCmdExecDirect.html

Executes the 'run' command on the calling thread.

```cpp
DbgCmdExecDirect("run");
```

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

### GuiLogClear example call

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiLogClear.html

Calls GuiLogClear to clear the log window.

```cpp
GuiLogClear();
```

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

### Example call to GuiUpdateSEHChain

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateSEHChain.html

Calls GuiUpdateSEHChain to refresh the SEH Chain view.

```c
GuiUpdateSEHChain();
```

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

### InitDebug/initdbg/init

Source: https://help.x64dbg.com/en/latest/commands/debug-control/index.html

Initializes the debugger. This command is used to start a debugging session.

```APIDOC
## InitDebug/initdbg/init

### Description
Initializes the debugger. This command is used to start a debugging session.

### Command
InitDebug

### Aliases
initdbg, init

### Arguments
- No arguments documented.

### Result
- No result documented.
```

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

### Example call: GuiScriptSetIp(0)

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiScriptSetIp.html

Sets the current line in the script view to line 0.

```c
GuiScriptSetIp(0);
```

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

### Example call: GuiUpdateGraphView()

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateGraphView.html

Calls the GuiUpdateGraphView function to refresh the Graph view.

```c
GuiUpdateGraphView();
```

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

### GuiUpdatePatches example call

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdatePatches.html

Calls GuiUpdatePatches to refresh the patches view.

```c
GuiUpdatePatches();
```

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

### Example call: GuiReferenceReloadData();

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiReferenceReloadData.html

Calls GuiReferenceReloadData to reload the data in the current Reference View instance.

```cpp
GuiReferenceReloadData();
```

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

### DbgArgumentGet

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgArgumentGet.html

Gets the boundaries of the given argument location as start and end addresses.

```APIDOC
## DbgArgumentGet

### Description
Gets the boundaries of the given argument location as start and end addresses.

### Method
Function

### Signature
bool DbgArgumentGet(duint addr, duint* start, duint* end);

### Parameters
- **addr** (duint) - Required - Address of the argument to fetch.
- **start** (duint*) - Required - Pointer to a duint variable that will hold the start address of the argument.
- **end** (duint*) - Required - Pointer to a duint variable that will hold the end address of the argument.

### Return Value
Returns TRUE if the start and end addresses are found, FALSE otherwise. If TRUE, the variables `start` and `end` will hold the fetched values.

### Example
```cpp
duint start;
duint end;
std::string message;

if(DbgArgumentGet(0x00401000, &start, &end))
{
  sprintf_s(message.c_str(), MAX_PATH, "Argument range: %08X-%08X\r\n", start, end);
  GuiAddLogMessage(message);
}
else
{
  GuiAddLogMessage("Argument start and end addresses couldn't be get\r\n");
}
```

### Related Functions
- DbgArgumentAdd
- DbgArgumentDel
- DbgArgumentOverlaps
```

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

### Example: GuiReferenceInitialize("Code Caves")

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiReferenceInitialize.html

Initializes a new Reference View instance named "Code Caves".

```c
GuiReferenceInitialize("Code Caves");
```

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

### Example call: GuiReferenceDeleteAllColumns()

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiReferenceDeleteAllColumns.html

Calls GuiReferenceDeleteAllColumns to remove all columns from the current Reference View instance.

```c
GuiReferenceDeleteAllColumns();
```

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

### plugsetup

Source: https://help.x64dbg.com/en/latest/developers/plugins/basics.html

Optional export called when the plugin initialization was successful. Use this to register menus and other GUI-related things.

```APIDOC
## plugsetup

### Description
Called when the plugin initialization was successful. Here you can register menus and other GUI-related things.

### Signature
```c
extern "C" __declspec(dllexport) void plugsetup(PLUG_SETUPSTRUCT* setupStruct);
```

### Parameters
- **setupStruct** (PLUG_SETUPSTRUCT*) - Required - Pointer to the plugin setup structure.
```

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

### Example call to GuiUpdateDisassemblyView

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateDisassemblyView.html

Calls GuiUpdateDisassemblyView to refresh the disassembly view (CPU tab).

```c
GuiUpdateDisassemblyView();
```

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

### Example call to GuiUpdateThreadView

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateThreadView.html

Calls GuiUpdateThreadView to refresh the threads view. No arguments are passed.

```c
GuiUpdateThreadView();
```

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

### GuiSelectionGet

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiSelectionGet.html

Gets the currently selected line (or lines) of the specified GUI view and returns the information as start and end addresses into a SELECTIONDATA variable.

```APIDOC
## GuiSelectionGet

### Description
Gets the currently selected line (or lines) of the specified GUI view and returns the information as start and end addresses into a SELECTIONDATA variable.

### Function Signature
`bool GuiSelectionGet(int hWindow, SELECTIONDATA* selection)`

### Parameters
- **hWindow** (int) - Required - An integer representing one of the following supported GUI views: GUI_DISASSEMBLY, GUI_DUMP, GUI_STACK.
- **selection** (SELECTIONDATA*) - Required - A SELECTIONDATA structure variable that stores the start and end address of the current selection.

### Return Value
Returns TRUE if successful or FALSE otherwise.

### Example
```
SELECTIONDATA sel;
GuiSelectionGet(GUI_DISASSEMBLY, &sel)
sprintf(msg, "%p - %p", sel.start, sel.end);
```

### Related Functions
- GuiSelectionSet
```

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

### Example call: GuiUpdateAllViews();

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateAllViews.html

Calls GuiUpdateAllViews to refresh all opened views. No parameters are required and no value is returned.

```cpp
GuiUpdateAllViews();
```

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

### GuiReferenceInitialize

Source: https://help.x64dbg.com/en/latest/developers/functions/index.html

Initializes the reference view in the x64dbg GUI.

```APIDOC
## GuiReferenceInitialize

### Description
Initializes the reference view in the x64dbg GUI.

### Function
`bool GuiReferenceInitialize()`

### Parameters
None.

### Return Value
- **bool** - Returns `true` on success, `false` on failure.
```

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

### DbgValSetScalar usage example

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgValSetScalar.html

Example call to DbgValSetScalar that sets the value of 'eax' to 1.

```cpp
DbgValSetScalar("eax", 1);
```

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

### PLUG_SETUPSTRUCT structure definition

Source: https://help.x64dbg.com/en/latest/developers/plugins/Structures/setupstruct.html

Defines the PLUG_SETUPSTRUCT structure with fields for the GUI window handle and menu handles for the main, disassembly, dump, and stack views. The [IN] annotations indicate these are provided by the debugger to the plugin.

```cpp
struct PLUG_SETUPSTRUCT
{
    //data provided by the debugger to the plugin.
    [IN] HWND hwndDlg; //GUI window handle
    [IN] int hMenu; //plugin menu handle
    [IN] int hMenuDisasm; //plugin disasm menu handle
    [IN] int hMenuDump; //plugin dump menu handle
    [IN] int hMenuStack; //plugin stack menu handle
};
```

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

### Example call: GuiReferenceSetRowCount(5)

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiReferenceSetRowCount.html

Sets the Reference View to contain 5 rows. This is a simple usage example.

```c
GuiReferenceSetRowCount(5);
```

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

### GuiMenuSetIcon usage example

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiMenuSetIcon.html

Shows how to set an icon for a menu entry. It initializes an ICONDATA structure with icon data and size, adds a new menu entry, and then sets the icon for the disassembly menu.

```c
ICONDATA rocket;
rocket.data = icon_rocket;
rocket.size = sizeof(icon_rocket);
hNewMenuEntry = GuiMenuAddEntry(hMenu, &szMenuEntryText);
GuiMenuSetIcon(hMenuDisasm,&rocket);
```

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

### DbgArgumentDel usage example

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgArgumentDel.html

Example usage of DbgArgumentDel. It deletes an argument at address 0x00401013 and logs a message based on the result.

```cpp
if(DbgArgumentDel(0x00401013))
  GuiAddLogMessage("Argument successfully deleted\r\n");
else
  GuiAddLogMessage("Argument couldn't be deleted\r\n");
```

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

### DbgArgumentGet usage example

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgArgumentGet.html

Example usage of DbgArgumentGet to retrieve and log the argument range. It checks the return value and logs a message if the addresses are not found.

```cpp
duint start;
duint end;
std::string message;

if(DbgArgumentGet(0x00401000, &start, &end))
{
  sprintf_s(message.c_str(), MAX_PATH, "Argument range: %08X-%08X\r\n", start, end);
  GuiAddLogMessage(message);
}
else
{
  GuiAddLogMessage("Argument start and end addresses couldn't be get\r\n");
}
```

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

### Example call: GuiScriptEnableHighlighting(true)

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiScriptEnableHighlighting.html

Enables syntax highlighting in the script view by passing true to the function.

```cpp
GuiScriptEnableHighlighting(true);
```

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

### Example usage: eip = DbgValFromString("cip")

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgValFromString.html

Example of calling DbgValFromString to evaluate the expression "cip" and assign the result to eip.

```c
eip = DbgValFromString("cip");
```

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

### GuiShowCpu

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/index.html

Shows the CPU view.

```APIDOC
## GuiShowCpu

### Description
Shows the CPU view.

### Function
GuiShowCpu

### Parameters
No parameters documented.

### Return Value
No return value documented.

```

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

### Example usage of DbgArgumentAdd

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgArgumentAdd.html

Example call to DbgArgumentAdd with a specific address range. If the function returns TRUE, a success message is logged; otherwise, a failure message is logged.

```cpp
if(DbgArgumentAdd(0x00401000, 0x00401013))
  GuiAddLogMessage("Argument successfully setted\r\n");
else
  GuiAddLogMessage("Argument couldn't be set\r\n");
```

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

### Assembly example: calling GuiAddLogMessage with data section

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiAddLogMessage.html

Shows a MASM example with a data section defining a null-terminated string with CRLF, and an invocation of GuiAddLogMessage using Invoke and Addr.

```assembly
.data
szMsg db "This text will be displayed in the log view",13,10,0 ; CRLF
    
.code
Invoke GuiAddLogMessage, Addr szMsg
```

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

### scriptdll/dllscript

Source: https://help.x64dbg.com/en/latest/commands/script/scriptdll.html

Executes a script DLL. The DLL must export either AsyncStart() or Start(). AsyncStart() runs on a separate thread, while Start() runs on the current thread and blocks further command execution.

```APIDOC
## scriptdll/dllscript

### Description
Executes a script DLL. The DLL must export either `AsyncStart()` or `Start()`. If `AsyncStart()` is exported, it runs on a separate thread; otherwise `Start()` runs on the current thread and blocks further command execution until it finishes.

### Command
`scriptdll arg1` or `dllscript arg1`

### Arguments
- **arg1** (string) - Required - The filename and path of the script DLL. If a full path is not provided, x64dbg will look in the `scripts` directory for the DLL.

### Results
This command does not set any result variables. However, the script DLL may set any variable.

### Remarks
- The DLL must export either `AsyncStart()` or `Start()`.
- If both are exported, only `AsyncStart()` is executed.
- Return values of `AsyncStart()` and `Start()` are not used.
- After execution, the DLL is unloaded from the process.
```

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

### Example usage of GuiGetGlobalNotes

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiGetGlobalNotes.html

Shows how to call GuiGetGlobalNotes, check the returned pointer, and free the buffer with BridgeFree.

```c
char* text = nullptr;
GuiGetGlobalNotes(&text);
if(text)
{
    // do something with text
    BridgeFree(text);
}
```

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

### GuiSelectionGet

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/index.html

Gets the current selection in the GUI.

```APIDOC
## GuiSelectionGet

### Description
Gets the current selection in the GUI.

### Function
GuiSelectionGet

### Parameters
No parameters documented.

### Return Value
No return value documented.

```

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

### Example: Setting an opmask value with DbgValSetBuffer

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgValSetBuffer.html

Shows how to set a value from a raw buffer. In this example, an unsigned long long variable named opmask is initialized to 1 and passed to DbgValSetBuffer with the name "_K0" and its size.

```cpp
unsigned long long opmask = 1;
DbgValSetBuffer("_K0", &opmask, sizeof(opmask));
```

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

### InitDebug

Source: https://help.x64dbg.com/en/latest/commands/debug-control/InitDebug.html

Initializes the debugger by loading the specified executable, setting breakpoints on TLS callbacks and the entry point, and breaking at the system breakpoint before returning control to the user.

```APIDOC
## InitDebug

### Description
Initializes the debugger. This command loads the executable, performs basic checks, sets breakpoints on TLS callbacks (if present), sets a breakpoint at the process entry point, and breaks at the system breakpoint before giving control back to the user.

### Command
InitDebug [arg1] [arg2] [arg3]

### Arguments
- **arg1** (string) - Required - Path to the executable file to debug. If no full path is given, the `GetCurrentDirectory` API will be called to retrieve a full path. Use quotation marks to include spaces in your path.
- **arg2** (string) - Optional - Commandline to create the process with.
- **arg3** (string) - Optional - Current folder (passed to the `CreateProcess` API) (also called 'working directory' or 'current directory').

### Result
This command gives control back to the user after the system breakpoint is reached. It sets the `$pid` and `$hp`/`$hProcess` variables.
```

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

### DbgSetBookmarkAt

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgSetBookmarkAt.html

Function definition and usage example for DbgSetBookmarkAt.

```APIDOC
## DbgSetBookmarkAt

### Description
Function description.

### Function Definition
```
Function definition.
```

### Parameters
- `param1` - Parameter description.

### Return Value
Return value description.

### Example
```
Example code.
```

### Related Functions
- List of related functions
```

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

### Example call: GuiUpdateArgumentWidget()

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiUpdateArgumentWidget.html

Calls GuiUpdateArgumentWidget to refresh the arguments widget. This function has no parameters and does not return a value.

```cpp
GuiUpdateArgumentWidget();
```

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

### DbgScriptBpGet

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgScriptBpGet.html

Function definition and usage example for DbgScriptBpGet.

```APIDOC
## DbgScriptBpGet

### Description
Function description.

### Function Definition
```
Function definition.
```

### Parameters
- `param1` - Parameter description.

### Return Value
Return value description.

### Example
```
Example code.
```

### Related Functions
- List of related functions
```

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

### DbgScriptCmdExec

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgScriptCmdExec.html

Function definition and usage example for DbgScriptCmdExec.

```APIDOC
## DbgScriptCmdExec

### Description
Function description.

### Function Definition
```
Function definition.
```

### Parameters
- `param1` - Parameter description.

### Return Value
Return value description.

### Example
```
Example code.
```

### Related Functions
- List of related functions
```

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

### Debug with command line arguments: x64dbg filename.exe cmdline

Source: https://help.x64dbg.com/en/latest/introduction/Commandline.html

Debugs the specified executable with the provided command line string.

```text
x64dbg filename.exe cmdline
```

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

### Example usage of GuiMenuSetEntryIcon

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiMenuSetEntryIcon.html

Shows how to set an icon for a menu entry. It initializes an ICONDATA structure with icon data and size, adds a new menu entry, and then sets the icon for that entry.

```c
ICONDATA rocket;
rocket.data = icon_rocket;
rocket.size = sizeof(icon_rocket);
hNewMenuEntry = GuiMenuAddEntry(hMenu, &szMenuEntryText);
GuiMenuSetEntryIcon(hNewMenuEntry,&rocket);
```

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

### DbgLoopGet

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgLoopGet.html

Function definition and usage example for DbgLoopGet.

```APIDOC
## DbgLoopGet

### Description
Function description.

### Function Definition
```
Function definition.
```

### Parameters
- `param1` - Parameter description.

### Return Value
Return value description.

### Example
```
Example code.
```

### Related Functions
- List of related functions
```

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

### DbgGetRegDump

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgGetRegDump.html

Function definition and example usage for DbgGetRegDump.

```APIDOC
## DbgGetRegDump

### Description
Function description.

### Function Definition
```
Function definition.
```

### Parameters
- `param1` - Parameter description.

### Return Value
Return value description.

### Example
```
Example code.
```

### Related Functions
- List of related functions
```

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

### DbgGetFunctionTypeAt

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgGetFunctionTypeAt.html

Function definition and usage example for DbgGetFunctionTypeAt.

```APIDOC
## DbgGetFunctionTypeAt

### Description
Function description.

### Function Definition
```
Function definition.
```

### Parameters
- `param1` - Parameter description.

### Return Value
Return value description.

### Example
```
Example code.
```

### Related Functions
- List of related functions
```

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

### DbgGetLabelAt

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgGetLabelAt.html

Function definition and usage example for DbgGetLabelAt.

```APIDOC
## DbgGetLabelAt

### Description
Function description.

### Function Definition
```
Function definition.
```

### Parameters
- `param1` - Parameter description.

### Return Value
Return value description.

### Example
```
Example code.
```

### Related Functions
- List of related functions
```

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

### pluginit

Source: https://help.x64dbg.com/en/latest/developers/plugins/basics.html

The mandatory export that must be implemented by every x64dbg plugin. It is called when the plugin is loaded and receives a PLUG_INITSTRUCT pointer for initialization.

```APIDOC
## pluginit

### Description
Mandatory export called when the plugin is loaded. Must be implemented by every plugin.

### Signature
```c
extern "C" __declspec(dllexport) bool pluginit(PLUG_INITSTRUCT* initStruct);
```

### Parameters
- **initStruct** (PLUG_INITSTRUCT*) - Required - Pointer to the plugin initialization structure.

### Returns
- **bool** - Return true on success, false on failure.
```

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

### DbgGetBranchDestination

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgGetBranchDestination.html

Function definition and usage example for DbgGetBranchDestination.

```APIDOC
## DbgGetBranchDestination

### Description
Function description.

### Function Definition
```
Function definition.
```

### Parameters
- `param1` - Parameter description.

### Return Value
Return value description.

### Example
```
Example code.
```

### Related Functions
- List of related functions

```

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

### DbgDisasmFastAt

Source: https://help.x64dbg.com/en/latest/developers/functions/debug/DbgDisasmFastAt.html

Function definition and usage example for DbgDisasmFastAt.

```APIDOC
## DbgDisasmFastAt

### Description
Function description.

### Function Definition
```
Function definition.
```

### Parameters
- `param1` - Parameter description.

### Return Value
Return value description.

### Example
```
Example code.
```

### Related Functions
- List of related functions

```

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

### stack.sel()

Source: https://help.x64dbg.com/en/latest/introduction/Expression-functions.html

Gets the selected address in the stack view.

```APIDOC
## stack.sel()

### Description
Gets the selected address in the stack view.

### Method
Expression Function

### Syntax
`stack.sel()`

### Returns
- Selected address (integer)
```

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

### Example call: GuiAddStatusBarMessage("This text will be displayed in the statusbar.")

Source: https://help.x64dbg.com/en/latest/developers/functions/gui/GuiAddStatusBarMessage.html

Shows how to call GuiAddStatusBarMessage with a string literal to display a message in the statusbar.

```c
GuiAddStatusBarMessage("This text will be displayed in the statusbar.");
```

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

### dump.sel()

Source: https://help.x64dbg.com/en/latest/introduction/Expression-functions.html

Gets the selected address in the dump view.

```APIDOC
## dump.sel()

### Description
Gets the selected address in the dump view.

### Method
Expression Function

### Syntax
`dump.sel()`

### Returns
- Selected address (integer)
```
Tokens:
Raw