VI class/VI Icon.Get As Image Data method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 421
Scope Basic Development Environment
Data Name VI Icon.Get as Image Data
Short Name* VI Icon.Get as Image Data
Long Name* VI Icon:Get As Image Data
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 2
Owning Class Name VI Class
Return Data Type No return value
Invoke Node VI Icon:Get As Image Data
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes (Read/Write)
Available with control VIsYes
Available with global VIsYes
Available with polymorphic VIsYes
Available with strict type definitionsNo
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Must wait until user interface is idleNo
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningYes

Returns the VI icon as a cluster of image data so you can draw it as a picture using the Draw Flattened Pixmap VI or save the image to a file using the Graphics Formats VIs.

You also can use the VI Icon:Save to File method to save an image of the VI icon to a file.

The clusters returned by this method are similar to the image data output of the Read JPEG File, Read PNG File, and Read BMP File VIs.

Parameters

Data type Name Required Description
Common Cluster TypeDef Color 256 Yes
Common Cluster TypeDef Color 16 Yes
Common Cluster TypeDef Monochrome Yes Returns information about the 1-bit VI icon. The Icon Editor dialog box saves icons in both 256-color (8-bit) and monochrome (1-bit) format.

Uses

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links