SafeHandle.DangerousAddRef(Boolean) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Manually increments the reference counter on SafeHandle instances.
public:
void DangerousAddRef(bool % success);[System.Security.SecurityCritical]
public void DangerousAddRef (ref bool success);public void DangerousAddRef (ref bool success);[<System.Security.SecurityCritical>]
member this.DangerousAddRef : bool -> unitmember this.DangerousAddRef : bool -> unitPublic Sub DangerousAddRef (ByRef success As Boolean)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.
