 |
font settings indicates what font settings currently are used in a report.
 |
charset is the character set to use for report text. The default is standard ASCII English. The default is -1.
|
 |
weight is the thickness of the font. The default is -1.
|
 |
name is the font name.
|
 |
size is the font size. In a standard report, size is the point size.
|
|
 |
margins sets the page margins to use when printing the report.
 |
margins sets the size of the page margins. The default is 1.00 for each margin.
If the margins are smaller than the minimum margins for the printer, the VI returns an error.
 |
top sets the distance in inches or centimeters between the top of the page and the top of the content on the page.
|
 |
left sets the distance in inches or centimeters between the left edge of the page and the left edge of the content on the page.
|
 |
right sets the distance in inches or centimeters between the right edge of the page and the right edge of the content on the page.
|
 |
bottom sets the distance in inches or centimeters between the bottom of the page and the bottom of the content on the page.
|
|
 |
measurement system sets the units of measurement for the margins.
| 0 | Default—Sets the margins in the measurement system configured on the computer. | | 1 | US—Sets the margins in inches. | | 2 | Metric—Sets the margins in centimeters. |
|
|
 |
text to be printed is the information you want to include in the report. Any information you want to include must be in a string.
| , the string \00 prints a blank page on some computers. If the VI does not behave as expected, make sure this string does not contain printer codes. |
|
 |
printer name or file path is the name of the printer to which you want to print a standard report or the file path to which you want to send an HTML report, depending on report type.
If you wire a printer name, that printer must be configured for use with the computer from which you want to print the report. If you do not wire a printer name, the VI uses the default printer for the computer. The computer from which you want to print must have a default printer.
If you wire a file path, you must enter it as a string or use the Path to String function. If you do not specify a path for an HTML report, LabVIEW displays error -41003.
|
 |
report type is the type of report you want to create.
| 0 | Standard Report (default)—Creates a report and returns a reference to it in report out so you can use other Report Generation VIs to customize or print the report. | | 1 | HTML—Creates an HTML report and returns a reference to it in report out so you can use other Report Generation VIs to customize, save, or print the report. |
|
 |
orientation specifies how the report appears when it is printed.
Use this input only with standard reports.
| 0 | Portrait (default)—Prints the report so the short edge of the paper is the top of the page. | | 1 | Landscape—Prints the report so the long edge of the paper is the top of the page. |
|
 |
error in describes error conditions that occur before this VI or function runs.
The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
 |
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
|
 |
code is the error or warning code. The default is 0.
If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
|
 |
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
|
|
 |
headers allows you to set up what information appears in the header of each page of the report.
 |
left is the information you want to appear in the left side of the header.
|
 |
center is the information you want to appear in the center portion of the header.
|
 |
right is the information you want to appear in the right side of the header.
|
|
 |
footers allows you to set up what information appears in the footer of each page of the report.
 |
left is the information you want to appear in the left side of the footer.
|
 |
center is the information you want to appear in the center portion of the footer.
|
 |
right is the information you want to appear in the right side of the footer.
|
|
 |
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
 |
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
|
 |
code is the error or warning code.
If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
|
 |
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
|
|
You cannot use this VI with any other Report Generation VIs. Also, this VI does not give you fine-grain control over the formatting of a report. You can use this VI to specify the text font, set the header and footer, set margins, specify a printer, and set the page orientation. This VI disposes of the report automatically, which frees memory space. However, you cannot control where information is placed, append information from another file, or clear the report of font styles, headers and footers, or text. Use the other Report Generation VIs to generate complicated reports, such as those with many different kinds of information.