Share via


TextTransformation.Dispose Method (Boolean)

Releases the unmanaged resources used by the TextTransformation and optionally releases the managed resources.

Namespace:  Microsoft.VisualStudio.TextTemplating
Assembly:  Microsoft.VisualStudio.TextTemplating.11.0 (in Microsoft.VisualStudio.TextTemplating.11.0.dll)

Syntax

'Declaration
Protected Overridable Sub Dispose ( _
    disposing As Boolean _
)
protected virtual void Dispose(
    bool disposing
)
protected:
virtual void Dispose(
    bool disposing
)
abstract Dispose : 
        disposing:bool -> unit  
override Dispose : 
        disposing:bool -> unit
protected function Dispose(
    disposing : boolean
)

Parameters

  • disposing
    Type: Boolean

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

If disposing is true, this method has been called by a user's code. If disposing is false, this method has been called by the garbage collector.

Classes that derive from TextTransformation should override Dispose(Boolean) to release their unmanaged resources.

This method is called by the public Dispose()method and the Finalize method. Dispose() invokes the protected Dispose(Boolean) method with the disposing parameter set to true. Finalize invokes Dispose with disposing set to false.

When the disposing parameter is true, this method releases all resources held by any managed objects that this TextTransformation references. This method invokes the Dispose() method of each referenced object.

Notes to Inheritors

Dispose can be called multiple times by other objects. When overriding Dispose(Boolean) be careful not to reference objects that have been previously disposed of in an earlier call to Dispose. For more information about how to implement Dispose(Boolean), see Implementing a Dispose Method.

For more information about Dispose and Finalize, see Cleaning Up Unmanaged Resources and Overriding the Finalize Method.

.NET Framework Security

See Also

Reference

TextTransformation Class

Dispose Overload

Microsoft.VisualStudio.TextTemplating Namespace

IDisposable

Finalize

Other Resources

Implementing a Dispose Method

Garbage Collection

Cleaning Up Unmanaged Resources

Overriding the Finalize Method