DocumentProperties.Dispose Method

Definition

Namespace:

Microsoft.VisualStudio.Package

Assembly:

Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:

Microsoft.VisualStudio.Package.LanguageService.15.0 v17.11.40262

Overloads

Dispose()	Cleans up the object.
Dispose(Boolean)	Cleans up the object and its resources.

Dispose()

Cleans up the object.

public:
 virtual void Dispose();

public:
 void Dispose();

void Dispose();

public void Dispose ();

abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit

Public Sub Dispose ()

Implements

Dispose()

Remarks

Call <xref:Namespace.Class.Dispose%2A> when you are finished using the DocumentProperties. The <xref:Namespace.Class.Dispose%2A> method leaves the DocumentProperties in an unusable state. After calling <xref:Namespace.Class.Dispose%2A>, you must release all references to the DocumentProperties so the garbage collector can reclaim the memory that the DocumentProperties was occupying. For more information, see Cleaning Up Unmanaged Resources and Implementing a Dispose Method.

Note

Always call <xref:Namespace.Class.Dispose%2A> before you release your last reference to the DocumentProperties. Otherwise, the resources it is using will not be freed until the garbage collector calls the DocumentProperties object's Finalize method.

Dispose(Boolean)

Cleans up the object and its resources.

protected:
 virtual void Dispose(bool disposing);

protected:
 virtual void Dispose(bool disposing);

 virtual void Dispose(bool disposing);

protected virtual void Dispose (bool disposing);

abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit

Protected Overridable Sub Dispose (disposing As Boolean)

Parameters

disposing

Boolean

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

Remarks

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 DocumentProperties 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.