DisposeGuard(Action,Boolean) Method

Invokes the specified action if the object is not disposed, optionally throwing an exception otherwise.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.AssertionMethodAttribute()>
Protected Overloads Sub DisposeGuard( _
   ByVal action As Action, _
   ByVal throwOnDisposed As Boolean _
)

'Usage
 
Dim instance As DisposableObject
Dim action As Action
Dim throwOnDisposed As Boolean
 
instance.DisposeGuard(action, throwOnDisposed)

[JetBrains.Annotations.AssertionMethod()]
protected void DisposeGuard( 
   Action action,
   bool throwOnDisposed
)

[JetBrains.Annotations.AssertionMethod()]
protected:
void DisposeGuard( 
   Action^ action,
   bool throwOnDisposed
)

Parameters

action: The action to be invoked.
The value of this parameter cannot be null (Nothing in Visual Basic).
throwOnDisposed: Whether to throw an exception when the object is disposed.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ObjectDisposedException	An operation was performed on a disposed object.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ObjectDisposedException An operation was performed on a disposed object.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

DisposableObject Class
DisposableObject Members
Overload List

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.