diff options
Diffstat (limited to 'python')
| -rw-r--r-- | python/__init__.py | 2 | ||||
| -rw-r--r-- | python/binaryview.py | 2 | ||||
| -rw-r--r-- | python/filemetadata.py | 2 |
3 files changed, 6 insertions, 0 deletions
diff --git a/python/__init__.py b/python/__init__.py index 1b36b2db..1fcdb77a 100644 --- a/python/__init__.py +++ b/python/__init__.py @@ -318,6 +318,8 @@ def load(*args, **kwargs) -> BinaryView: :rtype: :py:class:`BinaryView` :raises Exception: When a BinaryView could not be created + .. note:: The progress_func callback **must** return True to continue the load operation, False will abort the load operation. + :Example: >>> from binaryninja import * >>> with load("/bin/ls") as bv: diff --git a/python/binaryview.py b/python/binaryview.py index b7cb1a27..2b202735 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -1195,6 +1195,8 @@ class BinaryViewType(metaclass=_BinaryViewTypeMetaclass): :return: returns a :py:class:`BinaryView` object for the given filename or ``None`` :rtype: :py:class:`BinaryView` or ``None`` + .. note:: The progress_func callback **must** return True to continue the load operation, False will abort the load operation. + :Example: >>> from binaryninja import * >>> with load("/bin/ls") as bv: diff --git a/python/filemetadata.py b/python/filemetadata.py index d7330514..95cd8f7b 100644 --- a/python/filemetadata.py +++ b/python/filemetadata.py @@ -427,6 +427,8 @@ class FileMetadata: :return: true on success, false on failure :rtype: bool + .. note:: The progress_func callback **must** return True to continue the save operation, False will abort the save operation. + .. warning:: The calling thread must not hold a lock on the BinaryView instance as this action is run on the main thread which requires the lock. :Example: |