Control class/Get Image method

VI Server Method Information
Method ID	6331C0C
Scope	Basic Development Environment
Data Name	Get Image
Short Name*	Get Image
Long Name*	Get Image
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID	6
Owning Class Name	Control Class
Return Data Type	No return value
Invoke Node
Available in Real-Time Operating System	Yes
Available in Run-Time Engine	Yes (Read/Write)
Loads the block diagram into memory	No
Loads the front panel into memory	No
Need to authenticate before use	No
Remote access allowed	Yes
Settable when the VI is running	Yes

Returns an image of a front panel object.

This method is similar to the Front Panel:Get Image method.

If a front panel is not visible, LabVIEW does not update the values in the objects on the front panel. If you call a VI whose front panel is not visible and you use the Get Image method to create an image of a front panel object, the image does not reflect any value changes that occurred when you ran the VI.

If you want the image to reflect value changes, make sure the front panel is open before any values change. If you do not want to display the front panel but want the image to reflect value changes, create a Property Node from any terminal on the block diagram of the VI for which you want to create a front panel control image.

You also can use the Append Control Image to Report VI to create an image of a front panel object and append it to a report.

Parameters

Data type	Name	Required	Description
	Image Depth	No	Indicates 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.
	Background Color	No
	Image Data	No	Information about the image so you can use the Draw Flattened Pixmap VI to draw it as a picture or use the Graphics Formats VIs to save the image to a file.

History

Version	Change(s)
	More info to come.