SafeHandle.DangerousAddRef(Boolean) Method

Definition

Manually increments the reference counter on SafeHandle instances.

C#
[System.Security.SecurityCritical]
public void DangerousAddRef(ref bool success);
C#
public void DangerousAddRef(ref bool success);

Parameters

success
Boolean

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

Attributes

Exceptions

The SafeHandle has been disposed.

Remarks

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.

If this call is successful, it will set the ref bool success parameter to true and return successfully. If this call is unsuccessful, it will throw an exception and leave the ref bool success parameter unmodified.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

See also