diff options
| -rw-r--r-- | python/binaryview.py | 30 | ||||
| -rw-r--r-- | python/interaction.py | 8 |
2 files changed, 34 insertions, 4 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index 2a8f79ed..b316f24b 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -3701,9 +3701,39 @@ class BinaryView(object): core.BNShowPlainTextReport(self.handle, title, contents) def show_markdown_report(self, title, contents, plaintext = ""): + """ + ``show_markdown_report`` displays the markdown contents in UI applications and plaintext in command-line + applications. Markdown reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows: + ``binaryninja://?expr=_start`` Where ``expr=`` specifies an expression parsable by the `parse_expression` API. + + 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. + + :param str contents: markdown contents to display + :param str plaintext: Plain text version to display (used on the command-line) + :rtype: None + :Example: + >>> bv.show_markdown_report("title", "##Contents", "Plain text contents") + Plain text contents + """ core.BNShowMarkdownReport(self.handle, title, contents, plaintext) def show_html_report(self, title, contents, plaintext = ""): + """ + ``show_html_report`` displays the HTML contents in UI applications and plaintext in command-line + applications. HTML reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows: + ``binaryninja://?expr=_start`` Where ``expr=`` specifies an expression parsable by the `parse_expression` API. + + 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. + + :param str contents: HTML contents to display + :param str plaintext: Plain text version to display (used on the command-line) + :rtype: None + :Example: + >>> bv.show_html_report("title", "<h1>Contents</h1>", "Plain text contents") + Plain text contents + """ core.BNShowHTMLReport(self.handle, title, contents, plaintext) def show_graph_report(self, title, graph): diff --git a/python/interaction.py b/python/interaction.py index c01dd238..e9528397 100644 --- a/python/interaction.py +++ b/python/interaction.py @@ -643,8 +643,8 @@ def show_plain_text_report(title, contents): def show_markdown_report(title, contents, plaintext=""): """ ``show_markdown_report`` displays the markdown contents in UI applications and plaintext in command-line - applications. Markdown reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows: - ``binaryninja://?expr='_start'`` Where ``expr=`` specifies an expression parsable by the `parse_expression` API. + applications. This API doesn't support hyperlinking into the BinaryView, use the BinaryView.show_markdown_report + if hyperlinking is needed. 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. @@ -662,8 +662,8 @@ def show_markdown_report(title, contents, plaintext=""): def show_html_report(title, contents, plaintext=""): """ ``show_html_report`` displays the HTML contents in UI applications and plaintext in command-line - applications. HTML reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows: - ``binaryninja://?expr='_start'`` Where ``expr=`` specifies an expression parsable by the `parse_expression` API. + applications. This API doesn't support hyperlinking into the BinaryView, use the BinaryView.show_html_report + if hyperlinking is needed. 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. |