Variable.Delete Method

This method deletes the variable.

Namespace:  IntervalZero.MaxRT.Libraries.VariableDatabase
Assembly:  IntervalZero.MaxRT.Libraries (in IntervalZero.MaxRT.Libraries.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

Copy 
public void Delete(
    bool forceDelete,
    uint timeoutms
)

Parameters

forceDelete

Type: Boolean
Invalidates the containing database to delete even if other applications are open.

timeoutms

Type: UInt32
The timeout duration, in milliseconds, to wait for other applications to close the database.

Return Value

Type: void

InvalidOperationException is thrown when the variable is not open.

MaxRTNativeException is thrown when these errors occur:

Error code Meaning

ERROR_ABANDONED_WAIT_0

Failed to acquire the synchronization lock.

ERROR_ABANDONED_WAIT_63

One of the following conditions occurred:

  • Handles are still open in other applications and forceDelete is false.
  • The variable is closed but not deleted when this error is returned.

See Also: