SafeHandle.DangerousAddRef Method

Note: This method is new in the .NET Framework version 2.0.

Manually increments the reference counter on SafeHandle instances.

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

public:
void DangerousAddRef (
	bool% success
)
public void DangerousAddRef (
	/** @ref */ boolean success
)
JScript does not support passing value-type arguments by reference.

Parameters

success

true if the reference counter was successfully incremented; otherwise, false.

The DangerousAddRef method prevents the common language runtime from reclaiming memory used by a handle (which occurs when the runtime calls the ReleaseHandle method). You can use this method to manually increment the reference count on a SafeHandle instance. DangerousAddRef returns a Boolean value using a ref parameter (success) that indicates whether the reference count was incremented successfully. This allows your program logic to back out in case of failure. You should set success to false before calling DangerousAddRef. If success is true, avoid resource leaks by matching the call to DangerousAddRef with a corresponding call to DangerousRelease.

Caution noteCaution

This method is intended for advanced users and must always be used carefully. To avoid leaking handle resources, always call this method inside a constrained execution region (CER), where a thread abort cannot interrupt processing.

The following code example demonstrates how to use the DangerousAddRef, DangerousGetHandle, and DangerousRelease with a custom class called the MySafeHandle class that implements the SafeHandle class.

No code example is currently available or this language may not be supported.

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: