Module index

Module ida_registry

IDA Plugin SDK API wrapper: registry

Global variables

var ROOT_KEY_NAME
Key used to store IDA settings in registry (Windows version).this name is automatically prepended to all key names passed to functions in this file.
var reg_binary
reg_binary = 3
var reg_dword
reg_dword = 4
var reg_sz
reg_sz = 1
var reg_unknown
reg_unknown = 0

Functions

def reg_data_type(*args) ‑> regval_type_t
Get data type of a given value.
reg_data_type(name, subkey=None) -> regval_type_t
name: value name (C++: const char *)
subkey: key name (C++: const char *)
return: false if the [key+]value doesn't exist
def reg_delete(*args) ‑> bool
Delete a value from the registry.
reg_delete(name, subkey=None) -> bool
name: value name (C++: const char *)
subkey: parent key (C++: const char *)
return: success
def reg_delete_subkey(*args) ‑> bool
Delete a key from the registry.
reg_delete_subkey(name) -> bool
name (C++: const char *)
def reg_delete_tree(*args) ‑> bool
Delete a subtree from the registry.
reg_delete_tree(name) -> bool
name (C++: const char *)
def reg_exists(*args) ‑> bool
Is there already a value with the given name?
reg_exists(name, subkey=None) -> bool
name: value name (C++: const char *)
subkey: parent key (C++: const char *)
def reg_flush(*args) ‑> void
reg_flush()
def reg_load(*args) ‑> void
reg_load()
def reg_read_binary(*args) ‑> PyObject *
Read binary data from the registry.
reg_read_binary(name, subkey=None) -> PyObject *
name: value name (C++: const char *)
subkey: key name (C++: const char *)
return: success
def reg_read_bool(*args) ‑> bool
Read boolean value from the registry.
reg_read_bool(name, defval, subkey=None) -> bool
name: value name (C++: const char *)
defval: default value (C++: bool)
subkey: key name (C++: const char *)
return: boolean read from registry, or 'defval' if the read failed
def reg_read_int(*args) ‑> int
Read integer value from the registry.
reg_read_int(name, defval, subkey=None) -> int
name: value name (C++: const char *)
defval: default value (C++: int)
subkey: key name (C++: const char *)
return: the value read from the registry, or 'defval' if the read
failed
def reg_read_string(*args) ‑> PyObject *
Read a string from the registry.
reg_read_string(name, subkey=None, _def=None) -> PyObject *
name: value name (C++: const char *)
subkey: key name (C++: const char *) def: char const *
return: success
def reg_read_strlist(*args) ‑> qstrvec_t *
Retrieve all string values associated with the given key. Also see 'reg_update_strlist()' .
reg_read_strlist(subkey)
subkey (C++: const char *)
def reg_subkey_exists(*args) ‑> bool
Is there already a key with the given name?
reg_subkey_exists(name) -> bool
name (C++: const char *)
def reg_subkey_subkeys(*args) ‑> PyObject *
Get all subkey names of given key.
reg_subkey_subkeys(name) -> PyObject *
name (C++: const char *)
def reg_subkey_values(*args) ‑> PyObject *
Get all value names under given key.
reg_subkey_values(name) -> PyObject *
name (C++: const char *)
def reg_update_filestrlist(*args) ‑> void
Update registry with a file list. Case sensitivity will vary depending on the target OS.'add' and 'rem' must be UTF-8, just like for regular string operations.
reg_update_filestrlist(subkey, add, maxrecs, rem=None)
subkey (C++: const char *)
add (C++: const char *)
maxrecs (C++: size_t)
rem (C++: const char *)
def reg_update_strlist(*args) ‑> void
Update list of strings associated with given key.
reg_update_strlist(subkey, add, maxrecs, rem=None, ignorecase=False)
subkey: key name (C++: const char *)
add: string to be added to list, can be NULL (C++: const char
*)
maxrecs: limit list to this size (C++: size_t)
rem: string to be removed from list, can be NULL (C++: const
char *)
ignorecase: ignore case for 'add' and 'rem' (C++: bool)
def reg_write_binary(*args) ‑> PyObject *
Write binary data to the registry.
reg_write_binary(name, py_bytes, subkey=None) -> PyObject *
name: value name (C++: const char *) py_bytes: PyObject *
subkey: key name (C++: const char *)
def reg_write_bool(*args) ‑> void
Write boolean value to the registry.
reg_write_bool(name, value, subkey=None)
name: value name (C++: const char *)
value: boolean to write (nonzero = true) (C++: int)
subkey: key name (C++: const char *)
def reg_write_int(*args) ‑> void
Write integer value to the registry.
reg_write_int(name, value, subkey=None)
name: value name (C++: const char *)
value: value to write (C++: int)
subkey: key name (C++: const char *)
def reg_write_string(*args) ‑> void
Write a string to the registry.
reg_write_string(name, utf8, subkey=None)
name: value name (C++: const char *)
utf8: utf8-encoded string (C++: const char *)
subkey: key name (C++: const char *)