Creates a netlist report.

Syntax


Function ReportNetlist ( _
       ByVal probesFlag As Boolean, _
       ByVal format As ExportFormat, _
       [ByVal FileName As String]) _
       As String

Parameters

probesFlag—If True, this flag indicates that probes should be included in the report. If False, they will not be included and the output will be identical to that generated by the netlist report command from within Multisim.

format—the format to export the report in, as defined by the enum ExportFormat. For user readable output, use ExportText. For programmatic parsing of the output, use ExportCSV.

fileName—Indicates the name of the file to which the report should be written. If it is missing or blank, then the report will be returned in the output string.

Remarks

The report optionally includes probes. It is possible to identify them in the report because their "Pin" column is empty.

The report may be saved to a file or returned as a string. If the report is saved to a file, the fully-qualified path to the output file is returned. If the fileName is invalid, an error occurs. If there is no output, and fileName is specified, then no file is generated. If fileName is not specified, then the return string is blank.

Unicode strings are stored according to the global setting in Multisim, "Save .TXT files as plain text". This is found in the Save tab of the Global Options dialog box.

Example

' Generate a standard Netlist Report and save the output to a file


Dim report As String
report = Circuit.ReportNetlist(false, ExportText, "")

MsgBox report