NI System Configuration API Reference

Delete Resource (VI)

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

Permanently removes a hardware resource and its configuration data from the system. Not all devices can be deleted; consult your product documentation.

Delete Resource

crn.gif

Resource in is the resource object refnum returned from the Find Hardware VI.

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.

ci32.gif

Delete Mode specifies the conditions under which to delete the specified resource.

Validate but do not delete (-1)

Verify whether the resource can be deleted and whether it has dependencies.

Delete if no dependencies exist (0)

Delete the resource only if no dependencies exist. These could be tasks or child resources.

Delete item and any dependencies (1)

Delete this resource. If any dependencies exist, delete them too.

Delete item but keep dependencies (2)

Delete this resource. If any dependencies exist, leave them in an unusable state.

ibool.gif

Dependent Items Deleted returns whether resources other than the specified one were deleted. For example, this may happen if the resource is a simulated chassis that contained modules.

irn.gif

Resource out returns the resource that was deleted. If the call was successful, the only valid use of this resource is to call the Close VI.

istr.gif

Detailed Result returns a string containing results of any errors that may have occurred during the VI execution. This parameter also may return additional information about the results of the VI execution.

ierrcodeclst.gif

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

Log in to get a better experience