CGI VIs
Owning Palette: Internet Toolkit VIs
Installed With: Internet Toolkit. This topic might not match its corresponding palette in LabVIEW depending on your operating system, licensed product(s), and target.
Use the CGI VIs to build and execute CGI applications, to publish front panel images to the Web, and to maintain client-state information with HTTP cookies.
The VIs on this palette can return HTTP error codes.
| Palette Object | Description |
|---|---|
| CGI Add Params To Cookie | Adds all entries in the params keyed array except the Magic_Cookie entry to the cookie input. |
| CGI Build Cookie Document | Replaces placeholder text in an HTML document with a cookie ID. |
| CGI Build UNIX Path | Builds a UNIX-style path from the base path and absolute or relative path inputs. |
| CGI Build URL-Encoded Param String | Builds a URL-encoded parameter list from a keyed array. Use this VI to build the parameters for a link to a CGI application. |
| CGI Cookie | Returns a cookie using the REMOTE_ADDR environmental variable in the env input and cookie information in the params input. If a cookie does not exist, the VI creates one. |
| CGI Escape HTTP Param | Encodes characters in URL format, replacing all characters except for alphanumeric and underscore with %xx, where xx is the hexadecimal value of the character. |
| CGI Get Info | Returns path and name information about a CGI VI you are invoking. Use these values when a CGI VI builds an HTML document that contains links back to the VI. |
| CGI Get Panel Image | Takes a snapshot of a front panel and returns it in the format specified by the params input. |
| CGI Get Panel JPEG Image | Takes a snapshot of a front panel and returns it in JPEG format. |
| CGI Get Panel PNG Image | Takes a snapshot of a front panel and returns it in PNG format. |
| CGI Get Query Client Side Cookies | Returns the client-side cookies the browser sends, which contain the contents of the HTTP_COOKIE environmental variable in the env keyed array. |
| CGI Get Query Parameters | Returns the parameters that a CGI request contains. If the request contains a single parameter, the calling VI must use query string. If the request contains a list of parameters, the calling VI must use query params. |
| CGI IP Name To Names | Returns the IP and DNS address of the Internet address that name specifies. |
| CGI Parse URL-Encoded Param String | Returns the contents of a URL-encoded parameter list string in a keyed array. |
| CGI Path To Unix | Converts a platform-specific path to a string containing the path in UNIX style. |
| CGI Script Relative Path | Computes a path relative to the location of a CGI VI. |
| CGI Set Client Side Cookie | Constructs a Set-Cookie: reply header line that specifies a client-side cookie to store. The VI URL-encodes the cookie name and contents in the header. |
| CGI Set Multiple Client Side Cookies | Constructs Set-Cookie: reply header lines that specify multiple client-side cookies to store. The VI URL-encodes cookie names and contents. |
| CGI Spool Cookie | Returns the cookie associated with a specific CGI spool connection. If a cookie does not exist for the connection, the VI creates one. |
| CGI Translate Virtual Path | Converts a virtual path to an absolute path. A virtual path is the location of a file on a specific server, viewed by remote clients accessing the file. |
| CGI Unescape HTTP Param | Decodes characters from URL format, replacing the plus (+) character with white space and the %xx sequence with the character that corresponds to the hexadecimal value xx. |
| CGI Unix To Path | Converts a string consisting of a UNIX-style path to a platform-specific path. |
| Subpalette | Description |
|---|---|
| CGI Template VIs | Use CGI Template VIs to build CGI applications and to customize CGI VIs. |
| Cookie VIs | Use the Cookie VIs to create, edit, and delete HTTP cookies. |
| HTML VIs | Use the HTML VIs to create and edit HTML tags and documents in LabVIEW. |
| Keyed Array VIs | Use the Keyed Array VIs to create keyed arrays, in which two arrays link to each other and have values in sync. The Internet Toolkit uses keyed arrays to organize information such as cookie IDs. |