diff options
| author | Josh Ferrell <josh@vector35.com> | 2020-08-19 15:15:18 -0400 |
|---|---|---|
| committer | Josh Ferrell <josh@vector35.com> | 2020-08-19 15:15:18 -0400 |
| commit | d4804f23a48091f03f962d44a7a9c2fd6aeeee81 (patch) | |
| tree | 83c79dd2d951e9707d6b0a8c48e7eb0d03bb2b98 /python/binaryview.py | |
| parent | acea8a46cde62af24b0bca4d47ec56ad027d8f14 (diff) | |
Documentation for SaveSettings and SaveOption
Diffstat (limited to 'python/binaryview.py')
| -rw-r--r-- | python/binaryview.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index 1086035b..abcc5f49 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -2506,13 +2506,17 @@ class BinaryView(object): def create_database(self, filename, progress_func=None, settings=None): """ - ``create_database`` writes the current database (.bndb) file out to the specified file. + ``create_database`` writes the current database (.bndb) out to the specified file. :param str filename: path and filename to write the bndb to, this string `should` have ".bndb" appended to it. :param callback progress_func: optional function to be called with the current progress and total count. :param SaveSettings settings: optional argument for special save options. :return: true on success, false on failure :rtype: bool + :Example: + >>> settings = SaveSettings() + >>> bv.create_database(f"{bv.file.filename}.bndb", None, settings) + True """ return self._file.create_database(filename, progress_func, settings) |
