ida_registry Namespace Reference

Detailed Description

Registry related functions.

IDA uses the registry to store global configuration options that must persist after IDA has been closed.
On Windows, IDA uses the Windows registry directly. On Unix systems, the registry is stored in a file (typically ~/.idapro/ida.reg).
The root key for accessing IDA settings in the registry is defined by ROOT_KEY_NAME. 

Functions
'PyObject *'	reg_read_string (str name, str subkey=None, str _def=None)
'regval_type_t'	reg_data_type (str name, str subkey=None)
'PyObject *'	reg_read_binary (str name, str subkey=None)
'PyObject *'	reg_write_binary (str name, 'PyObject *' py_bytes, str subkey=None)
'PyObject *'	reg_subkey_subkeys (str name)
'PyObject *'	reg_subkey_values (str name)
bool	reg_delete_subkey (str name)
bool	reg_delete_tree (str name)
bool	reg_delete (str name, str subkey=None)
bool	reg_subkey_exists (str name)
bool	reg_exists (str name, str subkey=None)
'qstrvec_t *'	reg_read_strlist (str subkey)
None	reg_write_strlist ('qstrvec_t const &' _in, str subkey)
None	reg_update_strlist (str subkey, str add, 'size_t' maxrecs, str rem=None, bool ignorecase=False)
None	reg_write_string (str name, str utf8, str subkey=None)
int	reg_read_int (str name, int defval, str subkey=None)
None	reg_write_int (str name, int value, str subkey=None)
bool	reg_read_bool (str name, bool defval, str subkey=None)
None	reg_write_bool (str name, int value, str subkey=None)
None	reg_update_filestrlist (str subkey, str add, 'size_t' maxrecs, str rem=None)
bool	set_registry_name (str name)

Variables
	IDA_REGISTRY_NAME = _ida_registry.IDA_REGISTRY_NAME
	HVUI_REGISTRY_NAME = _ida_registry.HVUI_REGISTRY_NAME
	ROOT_KEY_NAME = _ida_registry.ROOT_KEY_NAME
	reg_unknown = _ida_registry.reg_unknown
	reg_sz = _ida_registry.reg_sz
	reg_binary = _ida_registry.reg_binary
	reg_dword = _ida_registry.reg_dword

Function Documentation

reg_data_type()

'regval_type_t' reg_data_type	(	str	name,
		str	subkey = None )

Get data type of a given value. 
    
@param name: value name
@param subkey: key name
@returns false if the [key+]value doesn't exist

reg_delete()

bool reg_delete	(	str	name,
		str	subkey = None )

Delete a value from the registry. 
    
@param name: value name
@param subkey: parent key
@returns success

reg_delete_subkey()

bool reg_delete_subkey

(

str

name

)

Delete a key from the registry.

reg_delete_tree()

bool reg_delete_tree

(

str

name

)

Delete a subtree from the registry.

reg_exists()

bool reg_exists	(	str	name,
		str	subkey = None )

Is there already a value with the given name? 
    
@param name: value name
@param subkey: parent key

reg_read_binary()

'PyObject *' reg_read_binary	(	str	name,
		str	subkey = None )

Read binary data from the registry. 
    
@param name: value name
@param subkey: key name
@returns false if 'data' is not large enough to hold all data present. in this case 'data' is left untouched.

reg_read_bool()

bool reg_read_bool	(	str	name,
		bool	defval,
		str	subkey = None )

Read boolean value from the registry. 
    
@param name: value name
@param defval: default value
@param subkey: key name
@returns boolean read from registry, or 'defval' if the read failed

reg_read_int()

int reg_read_int	(	str	name,
		int	defval,
		str	subkey = None )

Read integer value from the registry. 
    
@param name: value name
@param defval: default value
@param subkey: key name
@returns the value read from the registry, or 'defval' if the read failed

reg_read_string()

'PyObject *' reg_read_string	(	str	name,
		str	subkey = None,
		str	_def = None )

Read a string from the registry. 
    
@param name: value name
@param subkey: key name
@returns success

reg_read_strlist()

'qstrvec_t *' reg_read_strlist

(

str

subkey

)

Retrieve all string values associated with the given key. Also see reg_update_strlist(), reg_write_strlist() 

reg_subkey_exists()

bool reg_subkey_exists

(

str

name

)

Is there already a key with the given name?

reg_subkey_subkeys()

'PyObject *' reg_subkey_subkeys

(

str

name

)

Get all subkey names of given key.

reg_subkey_values()

'PyObject *' reg_subkey_values

(

str

name

)

Get all value names under given key.

reg_update_filestrlist()

None reg_update_filestrlist	(	str	subkey,
		str	add,
		'size_t'	maxrecs,
		str	rem = None )

Update registry with a file list. Case sensitivity will vary depending on the target OS. 

reg_update_strlist()

None reg_update_strlist	(	str	subkey,
		str	add,
		'size_t'	maxrecs,
		str	rem = None,
		bool	ignorecase = False )

Update list of strings associated with given key. 
    
@param subkey: key name
@param add: string to be added to list, can be nullptr
@param maxrecs: limit list to this size
@param rem: string to be removed from list, can be nullptr
@param ignorecase: ignore case for 'add' and 'rem'

reg_write_binary()

'PyObject *' reg_write_binary	(	str	name,
		'PyObject *'	py_bytes,
		str	subkey = None )

Write binary data to the registry. 
    
@param name: value name
@param subkey: key name

reg_write_bool()

None reg_write_bool	(	str	name,
		int	value,
		str	subkey = None )

Write boolean value to the registry. 
    
@param name: value name
@param value: boolean to write (nonzero = true)
@param subkey: key name

reg_write_int()

None reg_write_int	(	str	name,
		int	value,
		str	subkey = None )

Write integer value to the registry. 
    
@param name: value name
@param value: value to write
@param subkey: key name

reg_write_string()

None reg_write_string	(	str	name,
		str	utf8,
		str	subkey = None )

Write a string to the registry. 
    
@param name: value name
@param utf8: utf8-encoded string
@param subkey: key name

reg_write_strlist()

None reg_write_strlist	(	'qstrvec_t const &'	_in,
		str	subkey )

Write string values associated with the given key. Also see reg_read_strlist(), reg_update_strlist() 

set_registry_name()

bool set_registry_name

(

str

name

)

Variable Documentation

HVUI_REGISTRY_NAME

HVUI_REGISTRY_NAME = _ida_registry.HVUI_REGISTRY_NAME

IDA_REGISTRY_NAME

IDA_REGISTRY_NAME = _ida_registry.IDA_REGISTRY_NAME

reg_binary

reg_binary = _ida_registry.reg_binary

reg_dword

reg_dword = _ida_registry.reg_dword

reg_sz

reg_sz = _ida_registry.reg_sz

reg_unknown

reg_unknown = _ida_registry.reg_unknown

ROOT_KEY_NAME

ROOT_KEY_NAME = _ida_registry.ROOT_KEY_NAME