NI System Configuration API Reference

Rename Alias (VI)

  • Updated2023-02-21
  • 3 minute(s) read
Installed With: NI System Configuration

Changes the display name of a resource.

Rename Alias

cbool.gif

Update Dependencies updates dependencies (for example: a task or channel) if the resource being renamed has them. Dependencies will be updated to refer to the new name by default. Select FALSE if you do not want to update these dependencies.

Note   If Overwrite Conflict is TRUE and an existing resource was also renamed due to a conflict, the dependencies for that resource will not be updated. This option only affects the dependencies for the resource you are currently renaming.
crn.gif

Resource in specifies the resource to be changed.

cstr.gif

New Name is the user-specified new name for the resource.

cbool.gif

Overwrite Conflict allows resource name changes to occur if there are any naming conflicts. If this value is TRUE, the resource name change occurs even if another resource with the same name already exists. If this value is FALSE (default), this VI returns an error if another resource with the same name already exists. If this value is TRUE and you choose a name that is already assigned to an existing resource, this VI also changes the name of the existing resource. You can query the Overwritten Resource to determine the new name of that resource.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

cu32.gif

Remote Timeout specifies the time in milliseconds that this VI waits before it times out. The default amount of time that the VI waits for a response on the network before timing out is 5 minutes. In some cases, the operation may take longer to complete. This timeout is for remote systems only.

irn.gif

Resource out returns basic information about the system resource.

ibool.gif

Name Already Existed specifies whether or not a name overwrite took place. If TRUE, an overwrite occurred. If FALSE, an overwrite did not occur.

irn.gif

Overwritten Resource returns a reference to the resource whose name was overwritten. Call the Close (Hardware) VI on this reference when you no longer need it.

ierrcodeclst.gif

error out returns error information. This output provides standard error out functionality.

Log in to get a better experience