MCPcopy Create free account
hub / github.com/Vector35/binaryninja-api / show_markdown_report

Method show_markdown_report

python/binaryview.py:9376–9392  ·  view source on GitHub ↗

``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 pars

(self, title: str, contents: str, plaintext: str = "")

Source from the content-addressed store, hash-verified

9374 core.BNShowPlainTextReport(self.handle, title, contents)
9375
9376 def show_markdown_report(self, title: str, contents: str, plaintext: str = "") -> None:
9377 """
9378 ``show_markdown_report`` displays the markdown contents in UI applications and plaintext in command-line
9379 applications. Markdown reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows:
9380 ``binaryninja://?expr=_start`` Where ``expr=`` specifies an expression parsable by the :py:func:`parse_expression` API.
9381
9382 .. note:: This API functions differently on the command-line vs the UI. In the UI a pop-up is used. On the command-line \
9383 a simple text prompt is used.
9384
9385 :param str contents: markdown contents to display
9386 :param str plaintext: Plain text version to display (used on the command-line)
9387 :rtype: None
9388 :Example:
9389 >>> bv.show_markdown_report("title", "##Contents", "Plain text contents")
9390 Plain text contents
9391 """
9392 core.BNShowMarkdownReport(self.handle, title, contents, plaintext)
9393
9394 def show_html_report(self, title: str, contents: str, plaintext: str = "") -> None:
9395 """

Callers 1

display_bininfoFunction · 0.45

Calls

no outgoing calls

Tested by

no test coverage detected