diff options
| author | Peter LaFosse <peter@vector35.com> | 2023-03-21 10:33:23 -0400 |
|---|---|---|
| committer | Peter LaFosse <peter@vector35.com> | 2023-03-21 10:33:28 -0400 |
| commit | 94391b2730dcc2e6cfe9f26d13569b15c6d1a0ad (patch) | |
| tree | 466a83843d6026ba250343bc4d0ce1225640820d /python/binaryview.py | |
| parent | 808f72a50b6aab61ff3008fff7feb022a2abada2 (diff) | |
Update documentation for progress callbacks to indicate they must return True to continue the action
Diffstat (limited to 'python/binaryview.py')
| -rw-r--r-- | python/binaryview.py | 2 |
1 files changed, 2 insertions, 0 deletions
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: |