VI Icon:Save To File Method

Short Name: VI Icon.Save to File

Requires: Base Development System

Class: VI Methods

To Use: Create a method.

Saves an image of the VI icon to a file.

You also can use the VI Icon:Get As Image Data method to return the VI icon as a cluster of image data.

Parameters

Data typeNameRequiredDescription
Image FileYesAbsolute path where you want to save the image.
Image FormatNoFormat in which to save the image.

0PNG (default)
1JPEG
2GIF
3BMP
Image DepthNoSpecifies the color depth of the image, which is the number of bits to use to describe the color of each pixel in the image. Valid values include 1, 4, 8 (default), and 24 bits per pixel.

Remarks

The following table lists the characteristics of this method.

Data typeNo return value
Available in Run-Time EngineNo
Available in Real-Time Operating SystemYes
Settable when the VI is runningYes
Loads the front panel into memoryNo
Need to authenticate before useNo
Loads the block diagram into memoryNo
Remote access allowedYes
Must wait until user interface is idleNo
Available with control VIsYes
Available with global VIsYes
Available with strict type definitionsNo
Available with polymorphic VIsYes