Settings
Debugger settings can be controlled at runtime. Setting up consistent defaults may be important for scripts to run reproducibly.
API Method Reference
get_setting_str(section, setting_name)
Retrieves a string setting from the x64dbg configuration
Parameters:
Name | Type | Description | Default |
---|---|---|---|
section
|
str
|
The section of the setting |
required |
setting_name
|
str
|
The name of the setting |
required |
Returns:
Type | Description |
---|---|
str | None
|
The value of the setting or None if the setting was not found |
Source code in x64dbg_automate/commands_xauto.py
def get_setting_str(self, section: str, setting_name: str) -> str | None:
"""
Retrieves a string setting from the x64dbg configuration
Args:
section: The section of the setting
setting_name: The name of the setting
Returns:
The value of the setting or None if the setting was not found
"""
res, setting = self._send_request(XAutoCommand.XAUTO_REQ_DBG_READ_SETTING_SZ, section, setting_name)
if not res:
return None
return setting
get_setting_int(section, setting_name)
Retrieves a numeric setting from the x64dbg configuration
Parameters:
Name | Type | Description | Default |
---|---|---|---|
section
|
str
|
The section of the setting |
required |
setting_name
|
str
|
The name of the setting |
required |
Returns:
Type | Description |
---|---|
int | None
|
The value of the setting or None if the setting was not found |
Source code in x64dbg_automate/commands_xauto.py
def get_setting_int(self, section: str, setting_name: str) -> int | None:
"""
Retrieves a numeric setting from the x64dbg configuration
Args:
section: The section of the setting
setting_name: The name of the setting
Returns:
The value of the setting or None if the setting was not found
"""
res, setting = self._send_request(XAutoCommand.XAUTO_REQ_DBG_READ_SETTING_UINT, section, setting_name)
if not res:
return None
return setting
set_setting_str(section, setting_name, setting_val)
Sets a string setting in the x64dbg configuration
Parameters:
Name | Type | Description | Default |
---|---|---|---|
section
|
str
|
The section of the setting |
required |
setting_name
|
str
|
The name of the setting |
required |
setting_val
|
str
|
The desired value of the setting |
required |
Returns:
Type | Description |
---|---|
bool
|
Success |
Source code in x64dbg_automate/commands_xauto.py
def set_setting_str(self, section: str, setting_name: str, setting_val: str) -> bool:
"""
Sets a string setting in the x64dbg configuration
Args:
section: The section of the setting
setting_name: The name of the setting
setting_val: The desired value of the setting
Returns:
Success
"""
return self._send_request(XAutoCommand.XAUTO_REQ_DBG_WRITE_SETTING_SZ, section, setting_name, setting_val)
set_setting_int(section, setting_name, setting_val)
Sets a numeric setting in the x64dbg configuration
Parameters:
Name | Type | Description | Default |
---|---|---|---|
section
|
str
|
The section of the setting |
required |
setting_name
|
str
|
The name of the setting |
required |
setting_val
|
int
|
The desired value of the setting |
required |
Returns:
Type | Description |
---|---|
bool
|
Success |
Source code in x64dbg_automate/commands_xauto.py
def set_setting_int(self, section: str, setting_name: str, setting_val: int) -> bool:
"""
Sets a numeric setting in the x64dbg configuration
Args:
section: The section of the setting
setting_name: The name of the setting
setting_val: The desired value of the setting
Returns:
Success
"""
return self._send_request(XAutoCommand.XAUTO_REQ_DBG_WRITE_SETTING_UINT, section, setting_name, setting_val)