Information
Switch
Switch
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

GC::SuppressFinalize Method (Object^)

.NET Framework (current version)
 

Requests that the common language runtime not call the finalizer for the specified object.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

C#
C++
F#
VB
Copy 
public:
static void SuppressFinalize(
	Object^ obj
)

Parameters

obj
Type: System::Object^

The object whose finalizer must not be executed.

Exception Condition
ArgumentNullException

obj is null.

This method sets a bit in the object header of obj, which the runtime checks when calling finalizers. A finalizer, which is represented by the Object::Finalize method, is used to release unmanaged resources before an object is garbage-collected. If obj does not have a finalizer, the call to the SuppressFinalize method has no effect.

Objects that implement the IDisposable interface can call this method from the object's IDisposable::Dispose implementation to prevent the garbage collector from calling Object::Finalize on an object that does not require it. Typically, this is done to prevent the finalizer from releasing unmanaged resources that have already been freed by the IDisposable::Dispose implementation.

The following example demonstrates how to use the SuppressFinalize method in a resource class to prevent a redundant garbage collection from being called. The example uses the dispose pattern to free both managed resources (that is, objects that implement IDisposable) and unmanaged resources.

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: