Table Of Contents

File Dialog (G Dataflow)

Last Modified: March 27, 2017

Displays a dialog box with which a user can specify the path to a new or existing file or directory.

connector_pane_image
datatype_icon

button label

Text to display on the OK or Current Directory button in the file dialog box.

If button label is longer than the width of the button, the file dialog box does not display the entire label. The button is typically about 11 characters wide.

Default: Empty string

datatype_icon

prompt

Custom message that appears as the title of the file dialog box.

Default: Choose or Enter Path of File

datatype_icon

start path

Path of the directory whose contents are initially displayed in the file dialog box.

If start path is valid, but does not refer to an existing directory, this node strips names from the end of the path until the path is a valid directory path or an empty path. If start path is invalid, the last directory viewed in a file dialog box initially appears in the dialog box.

Default: No value — Displays the last directory viewed in a file dialog box

datatype_icon

default name

Name you want to appear as the initial file or directory name in the dialog box.

Default: Empty string

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

pattern

A string containing special characters that this node uses to restrict the files displayed. pattern does not restrict the directories displayed.

The pattern matching used by this node is similar to the matching used in matching wildcards in Windows filenames.

Character Meaning
? Matches any single character.
* Matches any sequence of zero or more characters.
; Separates patterns, allowing you to specify multiple allowable patterns. Do not insert whitespace following this character because this node interprets whitespace literally.
All other characters, including white space Matches the exact character.

Default: *.*

datatype_icon

pattern label

Text to display in the file dialog box next to the custom pattern. If you do not wire a string to pattern, this node ignores this input.

Default: All Files

datatype_icon

selected path

Absolute path to the file or directory selected using the file dialog box. If the user cancels the dialog box, this output returns <Not A Path>.

datatype_icon

exists?

A Boolean value that indicates whether selected path refers to an existing file or directory.

True selected path refers to an existing file or directory.
False selected path does not refer to an existing file or directory.
datatype_icon

cancelled?

A Boolean value that indicates whether the user cancelled the dialog box that appears if no input file was wired to this node.

True The dialog box was cancelled.
False The dialog box was not cancelled, or the dialog box did not appear.
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.

Where This Node Can Run:

Desktop OS: Windows

FPGA: DAQExpress does not support FPGA devices


Recently Viewed Topics