Table Of Contents

Move File or Folder (G Dataflow)

Version:
    Last Modified: April 3, 2017

    Moves a file or folder on disk to another disk location. If you move a folder, this node moves all the contents of the folder recursively to the new location.

    connector_pane_image
    datatype_icon

    prompt

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

    datatype_icon

    source path

    The absolute path to the file or folder on which you want to operate. If you do not wire a value to path, this node displays a dialog box from which you can select a file or folder. If you specify an empty or relative path, this node returns an error

    datatype_icon

    target path

    The new absolute path for the file or folder, including the new file or folder name.

    This node does not automatically append file extensions, such as .txt, to filenames when it copies or moves files. You must explicitly include the extension as a part of the new filename that you specify in target path.

    If target path is unwired, the node displays a dialog box from which to select a file or folder. This node behaves differently according to the file or directory you specify in target path.

    File or Directory Type Behavior
    Existing file Returns a Duplicate Path error.
    Existing directory Places the new file or directory inside the existing directory using the original file or directory name.
    Invalid, empty, or relative path Returns an error.

    Gaining Write Permission for a Specified File or Directory

    target path Set Permissions
    datatype_icon

    overwrite

    A Boolean value that determines whether the node replaces existing files or folders in the target path that have the same names as files or folders in the source path.

    True This node replaces existing files or folders in the target path. If you overwrite a folder that contains unique files, this node moves those files in the new folder. This node does not overwrite read-only files, even if you set this input to True.
    False This node keeps the existing files or folders in the target path.
    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

    new path

    New location of the file or directory. If the operation is unsuccessful, this output returns <Not A Path>.

    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: This product does not support FPGA devices


    Recently Viewed Topics