InsufficientMemoryException Class

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

InsufficientMemoryException.cs

The exception that is thrown when a check for sufficient available memory fails. This class cannot be inherited.

public ref class InsufficientMemoryException sealed : OutOfMemoryException

public sealed class InsufficientMemoryException : OutOfMemoryException

type InsufficientMemoryException = class
    inherit OutOfMemoryException

Public NotInheritable Class InsufficientMemoryException
Inherits OutOfMemoryException

Inheritance

Object

Exception

SystemException

OutOfMemoryException

InsufficientMemoryException

Remarks

Unlike OutOfMemoryException, InsufficientMemoryException is thrown before starting an operation, and thus does not imply state corruption. An application can catch this exception, throttle back its memory usage, and avoid actual out of memory conditions and their potential for corrupting program state.

This exception is thrown by the MemoryFailPoint constructor when you specify a projected memory allocation larger than the amount of currently available memory. Your program can catch the exception and either delay the task that needs the memory or execute it in smaller steps that require less memory.

See the MemoryFailPoint class for a code example.

Note

This exception is not included in the .NET for Windows Store apps or the Portable Class Library, but it is thrown by some members that are. To catch the exception in that case, write a catch statement for OutOfMemoryException instead.

Constructors

InsufficientMemoryException()	Initializes a new instance of the InsufficientMemoryException class with a system-supplied message that describes the error.
InsufficientMemoryException(String)	Initializes a new instance of the InsufficientMemoryException class with a specified message that describes the error.
InsufficientMemoryException(String, Exception)	Initializes a new instance of the InsufficientMemoryException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Properties

Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception)
HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception)
HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception)
InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception)
Message	Gets a message that describes the current exception. (Inherited from Exception)
Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception)
StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception)
TargetSite	Gets the method that throws the current exception. (Inherited from Exception)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetBaseException()	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext)	Obsolete. When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception)
GetType()	Gets the runtime type of the current instance. (Inherited from Exception)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Creates and returns a string representation of the current exception. (Inherited from Exception)

Events

SerializeObjectState

Obsolete. Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception)

See also

• MemoryFailPoint