Dispose(Boolean) Method

Syntax

protected virtual void Dispose( 
   bool disposing
)

protected:
virtual void Dispose( 
   bool disposing
)

Parameters

disposing: Indicates whether the method has been called directly or indirectly by a user's code.

Remarks

Derived classes must override this method if they use unmanaged resources or member variables that inherit from IDisposable. Use the following design pattern when overriding:

Example

Disposing a BLT Component

protected override void Dispose( bool disposing ) { if (IsDisposed() == false) // Base keeps disposing state management { if (disposing == true) { // Dispose of managed resources } // // Free any unmanaged resources // } base.Dispose( disposing ); // ask the base to dispose }

protected override void Dispose( bool disposing )
{
    if (IsDisposed() == false) // Base keeps disposing state management
    {
        if (disposing == true)
        {
            // Dispose of managed resources
        }
        // 
        // Free any unmanaged resources
        // 
    }
    base.Dispose( disposing );  // ask the base to dispose
}

Requirements

Target Platforms: For information on software requirements, see the AVEVA Enterprise SCADA Supported Configurations documentation.

AVEVA Enterprise SCADA BLT API Reference