summaryrefslogtreecommitdiff
path: root/python/interaction.py
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2020-02-06 11:14:51 -0500
committerJordan Wiens <jordan@psifertex.com>2020-02-06 11:14:51 -0500
commit982b0ccaade447a7ee49f8ab144ab534823f9e05 (patch)
tree1ebeb7f3c42b0b622edd5cbb70439e4b6c034565 /python/interaction.py
parentc34ac521dd6022d522053712833943c699bedb3f (diff)
correct get_form_input documentation for return value
Diffstat (limited to 'python/interaction.py')
-rw-r--r--python/interaction.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/python/interaction.py b/python/interaction.py
index 43004e2f..7f677e32 100644
--- a/python/interaction.py
+++ b/python/interaction.py
@@ -1227,12 +1227,12 @@ def get_form_input(fields, title):
- OpenFileNameField - Prompt for file to open
- SaveFileNameField - Prompt for file to save to
- DirectoryNameField - Prompt for directory name
- This API is flexible and works both in the UI via a pop-up dialog and on the command-line. Note that more complicated APIs should consider usin the included pyside2 functionality in the `binaryninjaui` module.
+ This API is flexible and works both in the UI via a pop-up dialog and on the command-line. Note that more complicated APIs should consider usin the included pyside2 functionality in the `binaryninjaui` module. Returns true or false depending on whether the user submitted responses or cancelled the dialog.
:param fields: A list containing these classes, strings or None
:type fields: list(str) or list(None) or list(LabelField) or list(SeparatorField) or list(TextLineField) or list(MultilineTextField) or list(IntegerField) or list(AddressField) or list(ChoiceField) or list(OpenFileNameField) or list(SaveFileNameField) or list(DirectoryNameField)
:param str title: The title of the pop-up dialog
- :rtype: None
+ :rtype: bool
:Example:
>>> int_f = IntegerField("Specify Integer")