Merges all objects of the source cluster into the target cluster.


icon

Inputs/Outputs

  • cbool.png wait for complete? (T) —

    wait for complete? Use this input to split the merging process into parts (for example, to display a progress bar).

  • cgenclassrntag.png target cluster in —

    target cluster in is the I/O name of the cluster where the source cluster is merged.

  • cgenclassrntag.png source cluster —

    source cluster is the I/O name of the cluster to be merged into the target cluster.

  • cu32.png copy mode —

    copy mode defines the merging behavior if the target cluster already contains elements with the same name.

  • cstr.png prefix —

    prefix is added to the source cluster name if an element with the same name exists in the target cluster.

  • cerrcodeclst.png error in (no error) —

    error in can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. Right-click the error in control on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

  • iu32.png percent complete —

    percent complete is used when wait for complete? is false.

  • igenclassrntag.png target cluster out —

    target cluster out is a copy of target cluster in. You can use this output to wire the VI to subsequent VIs.

  • ierrcodeclst.png error out —

    error out passes error or warning information out of a VI to be used by other VIs. Right-click the error out indicator on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

    • Description

    This VI merges all objects contained in the source cluster into the target cluster.

    The following VIs merge the objects with dependent-child objects:

    Copy mode and prefix are passed to the appropriate VI for the merging process.

    If the copy mode is set to Copy using source or Merge using source, all cluster properties including the name are copied from the source to the target cluster.

    Depending on the number of contained objects in the source and destination clusters, the execution can take longer. If wait for complete? is true, this VI waits until the merging process gets completed. If the execution completes without errors, percent complete returns 100. If wait for complete? is false, the function returns quickly and percent complete returns values less than 100. You must call the XNET Database Merge VI repeatedly until percent complete returns 100. You can use the time between calls to update a progress bar.