You are here: NI Home > Support > Product Reference > Manuals > LabVIEW Internet Toolkit 6.0.2 Help

Owning Palette: CGI VIs

Installed With: Internet Toolkit

Takes a snapshot of a front panel and returns it in PNG format.

	compression specifies the level of file compression you want for the PNG file. The quality of the graphic is not affected by the compression, but the graphic file size and speed of compression are affected by this value. Valid values range from –1 to 9 and balance file compression with speed. The following table lists example values for compression. -1 Good compression and speed (default) 0 No compression 1 Best speed with compression 9 Best compression
	depth is the bit depth of image (1, 4, 8, 24) to return. The default is the image depth that the server specifies.
	vi name is the name of the VI with a front panel you want to capture.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	entire panel determines whether the VI captures an image of the entire front panel or only the portion of the front panel that appears in the window. The default is FALSE, which returns the visible area of the front panel.
	content header contains a header line describing the content type of the image. Wire this output to the header input of the CGI Write Reply VI.
	content contains the front panel image in PNG format. Wire this output to the content input of the CGI Write Reply VI.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.