PrintVIToRTF Method

Installed With: Base Package

Class: VI Methods (ActiveX)

Saves the VI information to an RTF file.

Syntax

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

Parameters

Name	Type	Description
rtfFilePath	String	Path 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.
append	Boolean	Specifies whether the new information will be appended to an existing file. The default is FALSE.
format	PrintFormatEnum	Specifies which VI information to print and the format of the printout. You can select from eCustom, eStandard, eUsingPanel, eUsingSubVI, or eComplete.
imageFormat	Long	Format of the graphics file. The default is 0, which corresponds to the BMP format. BMP is the only format supported.
imageDepth	Long	Sets 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.
imageDirectory	String	Path 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.
helpFormat	Boolean	Specifies 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