diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2022-05-24 11:46:33 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2022-05-24 11:46:33 -0400 |
| commit | 6ddf5acb060f0b0a2648743a08d70e38ef5e9f47 (patch) | |
| tree | a4bc9b349a49656f3b65a6431ec851d86d9d7ea2 /python | |
| parent | 45a0ed721ba903df87098d52ceab2fe7f37bfd43 (diff) | |
update api docs for get_code_refs and get_data_refs
Diffstat (limited to 'python')
| -rw-r--r-- | python/binaryview.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index 6b9e818c..be4eab96 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -3909,6 +3909,8 @@ class BinaryView: This function returns both autoanalysis ("auto") and user-specified ("user") xrefs. To add a user-specified reference, see :func:`~Function.add_user_code_ref`. + The related :func:`get_data_refs` is used to find data references to an address unlike this API which returns references that exist in code. + :param int addr: virtual address to query for references :param int length: optional length of query :return: Generator[References] for the given virtual address @@ -3975,11 +3977,13 @@ class BinaryView: def get_data_refs(self, addr: int, length: int = None) -> Generator[int, None, None]: """ - ``get_data_refs`` returns a list of virtual addresses of data which references ``addr``. Optionally specifying + ``get_data_refs`` returns a list of virtual addresses of _data_ (not code) which references ``addr``, optionally specifying a length. When ``length`` is set ``get_data_refs`` returns the data which references in the range ``addr``-``addr``+``length``. This function returns both autoanalysis ("auto") and user-specified ("user") xrefs. To add a user-specified reference, see :func:`add_user_data_ref`. + .. warning:: If you're looking at this API, please double check that you don't mean to use :func:`get_code_refs` instead. + :param int addr: virtual address to query for references :param int length: optional length of query :return: list of integers |