Table Of Contents

Write to Binary File (G Dataflow)

Last Modified: January 9, 2017

Writes binary data to a file.

Programming Patterns

If you want to use Read from Binary File to read the array or string data you write to file, the prepend parameter must indicate TRUE. Otherwise, LabVIEW generates an error.

connector_pane_image
datatype_icon

prepend

A Boolean specifying whether LabVIEW includes data size information at the beginning of the file when data is an array.

TRUE LabVIEW includes data size information at the beginning of the file if data is an array.
FALSE LabVIEW does not include size information at the beginning of the file.

prepend controls only the top-level data size information. Arrays in clusters always include size information.

Default: TRUE

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 to which you want to write data.

This input can be a reference to a file or an absolute file path. In both cases, the node creates the specified file if it does not already exist. The node opens the specified file without requiring you to call Open/Create/Replace File first.

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

datatype_icon

data

The data to write to the file.

This node supports all data types except strings, arrays of strings, and clusters containing strings.

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

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