From 125f4010fa80db968a3a5fcf98cdfb67b60f05be Mon Sep 17 00:00:00 2001 From: Xusheng Date: Tue, 17 Nov 2020 17:48:35 +0800 Subject: improve documentation on BinaryViewEvent --- python/binaryview.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'python') 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. -- cgit v1.3.1