summaryrefslogtreecommitdiff
path: root/python/binaryview.py
diff options
context:
space:
mode:
authorXusheng <xusheng@vector35.com>2020-11-17 17:48:35 +0800
committerXusheng <xusheng@vector35.com>2021-01-07 17:40:53 +0800
commit125f4010fa80db968a3a5fcf98cdfb67b60f05be (patch)
tree4419bdd089f7eb18ce66efe1e863c5524f42f1b8 /python/binaryview.py
parent85e6371753022a473e71def8ecaca411a360c1d4 (diff)
improve documentation on BinaryViewEvent
Diffstat (limited to 'python/binaryview.py')
-rw-r--r--python/binaryview.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index 8678f4dc..e3823590 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -260,9 +260,14 @@ class BinaryViewEvent(object):
"""
The ``BinaryViewEvent`` object provides a mechanism for receiving callbacks when a BinaryView
is Finalized or the initial analysis is finished. The BinaryView finalized callbacks run before the
- intialanalysis starts. The callbacks run one-after-another in the same order as they get registered.
+ intial analysis starts. The callbacks run one-after-another in the same order as they get registered.
It is a good place to modify the BinaryView to add extra information to it.
+ For newly opened binaries, the initial analysis completion callbacks run after the initial analysis,
+ as well as linear sweep and signature matcher (if they are configured to run), completed. For loading
+ old databases, the callbacks run after the database is loaded, as well as any automatic analysis
+ update finishes.
+
The callback function receives a BinaryView as its parameter. It is possible to call
BinaryView.add_analysis_completion_event() on it to set up other callbacks for analysis completion.