Table Of Contents

Write to Binary File (G Dataflow)

Version:
    Last Modified: April 3, 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 input must indicate True. Otherwise, this node generates an error.

    connector_pane_image
    datatype_icon

    prepend

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

    True Includes data size information at the beginning of the file if data is an array.
    False 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 the input 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.

    datatype_icon

    data

    The data to write to the file.

    This input accepts scalar data of any type, arrays of data of any type, and clusters of data of any type.

    String Encoding

    This node writes string data using UTF-8 encoding.

    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 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.

    Default: 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.

    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

    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.
    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.

    Permissions for Write to Binary File

    Use the Set File Position node if you need to perform random access file reads or writes.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics