class documentation

class FunctionSymbol(Symbol):

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method __repr__ Undocumented
Property demangled_name Property: The long, demangled, form of the symbol, if available.
Property name_only Property: The short, demangled, form of the symbol, if available.
Property prototype Property: The long, demangled, form of the symbol, if available.

Inherited from Symbol:

Method __eq__ Compares the instance for equality with an object.
Method __ge__ Undocumented
Method __gt__ Undocumented
Method __hash__ Returns the hash for this value.
Method __le__ Undocumented
Method __lt__ Undocumented
Method __ne__ Compares the instance for equality with an object.
Method __str__ Returns the nicely printable string representation of this instance.
Property binary Property: The binary in which the symbol have been declared.
Property name Property: The name of the symbol.
Property rva Property: The relative virtual address (rva) inside the binary.
Property source_name Property: The name of the symbol as it is found in the binary or the debug file without any transformation.
Instance Variable _binary_id Undocumented
Instance Variable _datasource Undocumented
Instance Variable _symbol Undocumented
def __init__(self, _datasource, _binary_id, _symbol):

Undocumented

Parameters
_datasource:DataSourceUndocumented
_binary_id:strUndocumented
_symbol:_reven_api.SymbolUndocumented
def __repr__(self):

Undocumented

Returns
strUndocumented
@property
demangled_name: _Optional[str] =

Property: The long, demangled, form of the symbol, if available.

This form includes the name of the function symbol, all attributes (such as calling convention), all arguments and the return type that constitute its signature, if available.

Depending on the source language, for some symbols this form can be equal to the name_only form, or missing entirely.

Examples

>>> symbol.demangled_name
'public: __cdecl COREDEVICEACCESS::COREDEVICEACCESS(class DXGDEVICE * const,
                                                    enum _DXGDEVICEACCESS_TYPE,
                                                    unsigned int,bool)'

Information

Returns
Either a string if the prototype is available or None.
@property
name_only: _Optional[str] =

Property: The short, demangled, form of the symbol, if available.

This form only includes the name of the function symbol and omits any attribute (such as calling convention), arguments and return type. However, this form does include the path (namespace) and template arguments.

Depending on the source language, for some symbols this form can be missing entirely.

Examples

>>> symbol.name_only
'COREDEVICEACCESS::COREDEVICEACCESS'

Information

Returns
Either a string if the name only is available or None.
@property
@_deprecated(version='2.11.0', reason='Use demangled_name property')
prototype: _Optional[str] =

Property: The long, demangled, form of the symbol, if available.

This form includes the name of the function symbol, all attributes (such as calling convention), all arguments and the return type that constitute its signature, if available.

Depending on the source language, for some symbols this form can be equal to the name_only form, or missing entirely.

Examples

>>> symbol.prototype
'public: __cdecl COREDEVICEACCESS::COREDEVICEACCESS(class DXGDEVICE * const,
                                                    enum _DXGDEVICEACCESS_TYPE,
                                                    unsigned int,bool)'

Information

Returns
Either a string if the prototype is available or None.