PrintVIToRTF Method

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Requires: Base Development System

Class: VI Methods (ActiveX)

Saves the VI information to an RTF file.

Syntax

object.PrintVIToRTF(rtfFilePath, [append], [format], [imageFormat], [imageDepth], [imageDirectory], [helpFormat])

Parameters

NameTypeDescription
rtfFilePathStringPath to the RTF file in which you want to save the VI information. The directory in which you want to save the file must already exist, and you must specify a full path including the RTF filename.
appendBooleanSpecifies whether the new information will be appended to an existing file. The default is FALSE.
formatPrintFormatEnumSpecifies which VI information to print and the format of the printout. You can select from eCustom, eStandard, eUsingPanel, eUsingSubVI, or eComplete.
imageFormatLongFormat of the graphics file. The default is 0, which corresponds to the BMP format. BMP is the only format supported.
imageDepthLongSets the color depth, or number of supported colors, of the image: 1 (1-bit, black and white), 4 (4-bit, 16 colors), 8 (8-bit, 256 colors), or 24 (24-bit, true color). The default is 8.
imageDirectoryStringPath to the directory in which you want to save the graphic files. The directory in which you want to save the files must already exist. If not specified, LabVIEW saves the image files in the same directory as the HTML or RTF file.
helpFormatBooleanSpecifies whether to save the graphics externally and place references in the RTF file. Set this parameter to TRUE if you are creating a help file. The default is FALSE.

Return Value

none

WAS THIS ARTICLE HELPFUL?

Not Helpful