summaryrefslogtreecommitdiff
path: root/python/interaction.py
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2020-03-06 11:32:16 -0500
committerJordan Wiens <jordan@psifertex.com>2020-03-06 11:32:16 -0500
commitf2d151290c60d3be38ef2dc55153d17b91cf5ef9 (patch)
tree60ff646e0f84b38a79464b41ef344848c27071cc /python/interaction.py
parent6dac1141475ccaa0648197272d50c319c3436874 (diff)
update documentation on get_open_filename
Diffstat (limited to 'python/interaction.py')
-rw-r--r--python/interaction.py11
1 files changed, 8 insertions, 3 deletions
diff --git a/python/interaction.py b/python/interaction.py
index 7f677e32..7226178a 100644
--- a/python/interaction.py
+++ b/python/interaction.py
@@ -1150,12 +1150,17 @@ def get_open_filename_input(prompt, ext=""):
Note: This API function differently on the command-line vs the UI. In the UI a pop-up is used. On the command-line
a simple text prompt is used. The UI uses the native window pop-up for file selection.
+ Multiple file selection groups can be included if separated by two semicolons. Multiple file wildcards may be specified by using a space within the parenthesis.
+
+ Also, a simple selector of "*.extension" by itself may also be used instead of specifying the description.
+
:param str prompt: Prompt to display.
:param str ext: Optional, file extension
:Example:
- >>> get_open_filename_input("filename:", "exe")
- filename: foo.exe
- 'foo.exe'
+ >>> get_open_filename_input("filename:", "Executables (*.exe *.com);;Python Files (*.py);;All Files (*)")
+ b'foo.exe'
+ >>> get_open_filename_input("filename:", "*.py")
+ b'test.py'
"""
value = ctypes.c_char_p()
if not core.BNGetOpenFileNameInput(value, prompt, ext):