VI Icon:Save To File
- Updated2025-07-30
- 2 minute(s) read
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
| Name | Data type | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Image File |  |
Yes | Absolute path where you want to save the image. |
||||||||
| Image Format |  |
No | Format in which to save the image.
|
||||||||
| Image Depth |  |
No | Specifies 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.
| Short Name | VI Icon.Save to File |
| Data type | No return value |
| Available in Run-Time Engine | No |
| Available in Real-Time Operating System | No |
| Settable when the VI is running | Yes |
| Loads the front panel into memory | No |
| Need to authenticate before use | No |
| Loads the block diagram into memory | No |
| Remote access allowed | Yes |
| Must wait until user interface is idle | No |
| Available with control VIs | Yes |
| Available with global VIs | Yes |
| Available with strict type definitions | No |
| Available with polymorphic VIs | Yes |