From 9:00 AM - 12:00 PM CDT on Saturday, June 6th, ni.com will be undergoing system upgrades that may result in temporary service interruption.

We appreciate your patience as we improve our online experience.

Table Of Contents

OPTIONS (G Dataflow)

Last Modified: August 21, 2019

Sends a web request returning headers and body data from a server, web page, or web service. This node uses the OPTIONS HTTP method and does not submit any data to the server.

connector_pane_image
datatype_icon

output file

File where you can save body data returned by the server. If you do not specify an output file, the node does not save the body data to a file.

datatype_icon

client handle

Unique value that identifies the web request. You can use the same client handle to wire together multiple HTTP nodes to preserve authentication credentials, HTTP headers, and cookies. Client handles are not required when making independent web requests without persistent data such as headers or credentials.

Default: 0

datatype_icon

url

URL of the server, web page, or web service where this node will send the web request.

Relative URL behavior

If you do not specify a URL scheme on a Web Server target, each URL you enter is relative to the location the WebVI is hosted. The WebVI sends HTTP requests to the server at the relative URL. For example, if you host the WebVI on http://website.com/MyApp/, specifying the relative URL subdirectory/myfile.txt sends an HTTP request to http://website.com/MyApp/subdirectory/myfile.txt.

If you do not specify a URL scheme on a non-Web Server target, the node prefixes http:// to the URL and treats it as an absolute URL.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

timeout

Amount of time in milliseconds you must wait to obtain a response from the server before the web request times out. A value of -1 defers timeout monitoring to the operating system.

Default: 10000 ms

datatype_icon

client handle out

Unique value that identifies the web request. Use this value to refer to this web request in subsequent node calls.

You can use the same client handle to wire together multiple HTTP nodes to preserve authentication credentials and HTTP headers.

Client handles are not required when making independent web requests without persistent data such as headers or credentials.

datatype_icon

headers

Headers associated with the client handle.

datatype_icon

body

Body data contained in the server, web page, or web service.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
datatype_icon

status code

Status code information returned by the server.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics