Table Of Contents

Read from Binary File (G Dataflow)

Last Modified: January 9, 2017

Reads binary data from a file, interpreting the data as a specified data type.

connector_pane_image
datatype_icon

data type

The data type that this node uses to read the binary file. By specifying the data type, you control how the node interprets the binary data.

This input does not support strings.

Default: 1D array of U8 numerics

datatype_icon

prompt

Custom message in the title bar of the file dialog box that appears when you do not wire a value to file path.

datatype_icon

file path

The file that this node reads.

This input can be a reference to a file or an absolute file path. The node opens the specified file without requiring you to call Open/Create/Replace File first.

If you specify an empty path, a relative path, or a path to a non-existent file, this node returns an error.

Default: No value — Displays a file dialog box that prompts you to select a file.

datatype_icon

count

The maximum number of data elements to read. Data elements are instances of the specified data type.

If this node reaches the end of the file before reading the specified number of data elements, the node returns the available data elements along with an end-of-file error. If count is -1, the node reads the entire file, unless the size of the file is too large to be represented by a 32-bit integer. In this case, the node returns an error. If count is less than -1, the node returns an error.

Default: 1

datatype_icon

byte order

The endian form that the node uses to interpret the binary file. Byte order, or endian form, indicates whether integers are represented in memory from most-significant byte to least-significant byte or vice versa. When reading a binary file, you must interpret the data in the same byte order in which the data was written.

Name Description
big-endian, network order

The most-significant byte occupies the lowest memory address. This endian form is used on PowerPC platforms such as VxWorks. This endian-form also is used when reading data written on a different platform.

native, host order

Uses the byte-ordering format of the host computer. This endian form increases read and write speed.

little-endian

The least-significant byte occupies the lowest memory address. This endian form is used on Windows, Mac OS X, and Linux.

Default: 0 big-endian, network order

datatype_icon

error in

Error conditions that occur before this node runs. The node responds to this input according to standard error behavior.

Default: No error

datatype_icon

refnum out

A reference to the file that this node uses.

datatype_icon

data

The data read from the file in the specified data type. It can consist of an array, a cluster of arrays, or an array of clusters, depending on which data type you are reading and the value you wired to count.

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.

Default: False

datatype_icon

error out

Error information. The node produces this output according to standard error behavior.

Where This Node Can Run:

Desktop OS: Windows

FPGA: All devices (only within an Optimized FPGA VI)


Recently Viewed Topics