summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGlenn Smith <glenn@vector35.com>2025-01-24 14:17:05 -0500
committerGlenn Smith <glenn@vector35.com>2025-01-24 14:17:05 -0500
commitbfa1d409b2d5e734804a5fdb4c68c90a93712f1f (patch)
treefc8c12b0dd2ae311e2c8a02ba7bc23804e902acf
parent8767400b712f12f459556844e27d9b9f5ff037bd (diff)
Update docs for get_save_filename_input to reflect actual api spec
-rw-r--r--python/interaction.py24
1 files changed, 21 insertions, 3 deletions
diff --git a/python/interaction.py b/python/interaction.py
index c3bfb3a2..c7cafec5 100644
--- a/python/interaction.py
+++ b/python/interaction.py
@@ -1273,10 +1273,16 @@ def get_open_filename_input(prompt: str, ext: str = "") -> Optional[str]:
:param str prompt: Prompt to display.
:param str ext: Optional, file extension
:Example:
- >>> get_open_filename_input("filename:", "Executables (*.exe *.com);;Python Files (*.py);;All Files (*)")
- 'foo.exe'
>>> get_open_filename_input("filename:", "*.py")
'test.py'
+ >>> get_open_filename_input("filename:", "All Files (*)")
+ 'test.py'
+ >>> get_open_filename_input("filename:", "Executables (*.exe)")
+ 'foo.exe'
+ >>> get_open_filename_input("filename:", "Executables (*.exe *.com)")
+ 'foo.exe'
+ >>> get_open_filename_input("filename:", "Executables (*.exe *.com);;Python Files (*.py);;All Files (*)")
+ 'foo.exe'
"""
value = ctypes.c_char_p()
if not core.BNGetOpenFileNameInput(value, prompt, ext):
@@ -1299,7 +1305,19 @@ def get_save_filename_input(prompt: str, ext: str = "", default_name: str = "")
:param str ext: Optional, file extension
:param str default_name: Optional, default file name.
:Example:
- >>> get_save_filename_input("filename:", "exe", "foo.exe")
+ >>> get_save_filename_input("filename:", "*.py", "test.py")
+ filename: test.py
+ 'test.py'
+ >>> get_save_filename_input("filename:", "All Files (*)", "test.py")
+ filename: test.py
+ 'test.py'
+ >>> get_save_filename_input("filename:", "Executables (*.exe)", "foo.exe")
+ filename: foo.exe
+ 'foo.exe'
+ >>> get_save_filename_input("filename:", "Executables (*.exe *.com)", "foo.exe")
+ filename: foo.exe
+ 'foo.exe'
+ >>> get_save_filename_input("filename:", "Executables (*.exe *.com);;Python Files (*.py);;All Files (*)", "foo.exe")
filename: foo.exe
'foo.exe'
"""