StackOverflowException.xml

<TypeName="StackOverflowException"FullName="System.StackOverflowException">
 <TypeSignatureLanguage="C#"Value="public sealed class StackOverflowException : SystemException" />
 <TypeSignatureLanguage="ILAsm"Value=".class public auto ansi sealed beforefieldinit StackOverflowException extends System.SystemException"FrameworkAlternate="net-10.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netstandard-2.0;netstandard-2.1" />
 <TypeSignatureLanguage="DocId"Value="T:System.StackOverflowException" />
 <TypeSignatureLanguage="VB.NET"Value="Public NotInheritable Class StackOverflowException&#xA;Inherits SystemException" />
 <TypeSignatureLanguage="F#"Value="type StackOverflowException = class&#xA; inherit SystemException" />
 <TypeSignatureLanguage="C++ CLI"Value="public ref class StackOverflowException sealed : SystemException" />
 <TypeSignatureLanguage="ILAsm"Value=".class public auto ansi serializable sealed beforefieldinit StackOverflowException extends System.SystemException"FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
 <AssemblyInfo>
 <AssemblyName>mscorlib</AssemblyName>
 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 <AssemblyVersion>2.0.0.0</AssemblyVersion>
 <AssemblyVersion>2.0.5.0</AssemblyVersion>
 <AssemblyVersion>4.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <AssemblyInfo>
 <AssemblyName>netstandard</AssemblyName>
 <AssemblyVersion>2.0.0.0</AssemblyVersion>
 <AssemblyVersion>2.1.0.0</AssemblyVersion>
 </AssemblyInfo>
 <AssemblyInfo>
 <AssemblyName>System.Runtime</AssemblyName>
 <AssemblyVersion>4.2.0.0</AssemblyVersion>
 <AssemblyVersion>4.2.1.0</AssemblyVersion>
 <AssemblyVersion>4.2.2.0</AssemblyVersion>
 <AssemblyVersion>5.0.0.0</AssemblyVersion>
 <AssemblyVersion>6.0.0.0</AssemblyVersion>
 <AssemblyVersion>7.0.0.0</AssemblyVersion>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 <AssemblyVersion>9.0.0.0</AssemblyVersion>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <TypeForwardingChain>
 <TypeForwardingFrom="netstandard"FromVersion="2.1.0.0"To="System.Runtime"ToVersion="10.0.0.0"FrameworkAlternate="net-10.0" />
 <TypeForwardingFrom="netstandard"FromVersion="2.1.0.0"To="System.Runtime"ToVersion="5.0.0.0"FrameworkAlternate="net-5.0" />
 <TypeForwardingFrom="netstandard"FromVersion="2.1.0.0"To="System.Runtime"ToVersion="6.0.0.0"FrameworkAlternate="net-6.0" />
 <TypeForwardingFrom="netstandard"FromVersion="2.1.0.0"To="System.Runtime"ToVersion="7.0.0.0"FrameworkAlternate="net-7.0" />
 <TypeForwardingFrom="netstandard"FromVersion="2.1.0.0"To="System.Runtime"ToVersion="8.0.0.0"FrameworkAlternate="net-8.0" />
 <TypeForwardingFrom="netstandard"FromVersion="2.1.0.0"To="System.Runtime"ToVersion="9.0.0.0"FrameworkAlternate="net-9.0" />
 </TypeForwardingChain>
 <Base>
 <BaseTypeName>System.SystemException</BaseTypeName>
 </Base>
 <Interfaces />
 <Attributes>
 <AttributeFrameworkAlternate="net-10.0;net-8.0;net-9.0">
 <AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
 <AttributeNameLanguage="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
 </Attribute>
 <AttributeFrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
 <AttributeNameLanguage="C#">[System.Serializable]</AttributeName>
 <AttributeNameLanguage="F#">[&lt;System.Serializable&gt;]</AttributeName>
 </Attribute>
 <AttributeFrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
 <AttributeNameLanguage="C#">[System.Runtime.InteropServices.ComVisible(true)]</AttributeName>
 <AttributeNameLanguage="F#">[&lt;System.Runtime.InteropServices.ComVisible(true)&gt;]</AttributeName>
 </Attribute>
 </Attributes>
 <Docs>
 <summary>The exception that is thrown when the execution stack exceeds the stack size. This class cannot be inherited.</summary>
 <remarks>
 <formattype="text/markdown"><![CDATA[

## Remarks 
 `StackOverflowException` is thrown for execution stack overflow errors, typically in case of a very deep or unbounded recursion. So make sure your code doesn't have an infinite loop or infinite recursion.

 `StackOverflowException` uses the HRESULT COR_E_STACKOVERFLOW, which has the value 0x800703E9. The <xref:System.Reflection.Emit.OpCodes.Localloc> intermediate language (IL) instruction throws `StackOverflowException`. For a list of initial property values for a `StackOverflowException` object, see the <xref:System.StackOverflowException.%23ctor%2A> constructors. 

 Starting with the .NET Framework 2.0, you can't catch a `StackOverflowException` object with a `try`/`catch` block, and the corresponding process is terminated by default. Consequently, you should write your code to detect and prevent a stack overflow. For example, if your app depends on recursion, use a counter or a state condition to terminate the recursive loop.
See the [Examples](#examples) section for an illustration of this technique.

> [!NOTE]
> Applying the <xref:System.Runtime.ExceptionServices.HandleProcessCorruptedStateExceptionsAttribute> attribute to a method that throws a `StackOverflowException` has no effect. You still cannot handle the exception from user code.

 If your app hosts the common language runtime (CLR), it can specify that the CLR should unload the application domain where the stack overflow exception occurs and let the corresponding process continue. For more information, see [ICLRPolicyManager Interface](/dotnet/framework/unmanaged-api/hosting/iclrpolicymanager-interface).

## Examples

 The following example uses a counter to ensure that the number of recursive calls to the `Execute` method do not exceed a maximum defined by the MAX_RECURSIVE_CALLS constant.

 :::code language="csharp" source="~/snippets/csharp/System/StackOverflowException/Overview/example1a.cs" interactive="try-dotnet" id="Snippet1":::
 :::code language="fsharp" source="~/snippets/fsharp/System/StackOverflowException/Overview/example1a.fs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.stackoverflowexception.class/vb/example1a.vb" id="Snippet1":::

]]></format>
 </remarks>
 <altmembercref="T:System.Exception" />
 <relatedtype="Article"href="/dotnet/standard/exceptions/">Handling and Throwing Exceptions</related>
 </Docs>
 <Members>
 <MemberGroupMemberName=".ctor">
 <AssemblyInfo>
 <AssemblyName>mscorlib</AssemblyName>
 <AssemblyVersion>2.0.5.0</AssemblyVersion>
 <AssemblyVersion>4.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Docs>
 <summary>Initializes a new instance of the <seecref="T:System.StackOverflowException" /> class.</summary>
 </Docs>
 </MemberGroup>
 <MemberMemberName=".ctor">
 <MemberSignatureLanguage="C#"Value="public StackOverflowException ();" />
 <MemberSignatureLanguage="ILAsm"Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
 <MemberSignatureLanguage="DocId"Value="M:System.StackOverflowException.#ctor" />
 <MemberSignatureLanguage="VB.NET"Value="Public Sub New ()" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; StackOverflowException();" />
 <MemberType>Constructor</MemberType>
 <AssemblyInfo>
 <AssemblyName>mscorlib</AssemblyName>
 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 <AssemblyVersion>2.0.0.0</AssemblyVersion>
 <AssemblyVersion>2.0.5.0</AssemblyVersion>
 <AssemblyVersion>4.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <AssemblyInfo>
 <AssemblyName>netstandard</AssemblyName>
 <AssemblyVersion>2.0.0.0</AssemblyVersion>
 <AssemblyVersion>2.1.0.0</AssemblyVersion>
 </AssemblyInfo>
 <AssemblyInfo>
 <AssemblyName>System.Runtime</AssemblyName>
 <AssemblyVersion>4.2.0.0</AssemblyVersion>
 <AssemblyVersion>4.2.1.0</AssemblyVersion>
 <AssemblyVersion>4.2.2.0</AssemblyVersion>
 <AssemblyVersion>5.0.0.0</AssemblyVersion>
 <AssemblyVersion>6.0.0.0</AssemblyVersion>
 <AssemblyVersion>7.0.0.0</AssemblyVersion>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 <AssemblyVersion>9.0.0.0</AssemblyVersion>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Parameters />
 <Docs>
 <summary>Initializes a new instance of the <seecref="T:System.StackOverflowException" /> class, setting the <seecref="P:System.Exception.Message" /> property of the new instance to a system-supplied message that describes the error, such as "The requested operation caused a stack overflow." This message takes into account the current system culture.</summary>
 <remarks>
 <formattype="text/markdown"><![CDATA[

## Remarks 
 The following table shows the initial property values for an instance of <xref:System.StackOverflowException>. 

|Property|Value| 
|--------------|-----------| 
|<xref:System.Exception.InnerException%2A>|`null`.| 
|<xref:System.Exception.Message%2A>|The localized error message string.| 

]]></format>
 </remarks>
 </Docs>
 </Member>
 <MemberMemberName=".ctor">
 <MemberSignatureLanguage="C#"Value="public StackOverflowException (string? message);"FrameworkAlternate="net-10.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netcore-3.0;netcore-3.1" />
 <MemberSignatureLanguage="ILAsm"Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message) cil managed" />
 <MemberSignatureLanguage="DocId"Value="M:System.StackOverflowException.#ctor(System.String)" />
 <MemberSignatureLanguage="VB.NET"Value="Public Sub New (message As String)" />
 <MemberSignatureLanguage="F#"Value="new StackOverflowException : string -&gt; StackOverflowException"Usage="new System.StackOverflowException message" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; StackOverflowException(System::String ^ message);" />
 <MemberSignatureLanguage="C#"Value="public StackOverflowException (string message);"FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0;netstandard-2.1" />
 <MemberType>Constructor</MemberType>
 <AssemblyInfo>
 <AssemblyName>mscorlib</AssemblyName>
 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 <AssemblyVersion>2.0.0.0</AssemblyVersion>
 <AssemblyVersion>2.0.5.0</AssemblyVersion>
 <AssemblyVersion>4.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <AssemblyInfo>
 <AssemblyName>netstandard</AssemblyName>
 <AssemblyVersion>2.0.0.0</AssemblyVersion>
 <AssemblyVersion>2.1.0.0</AssemblyVersion>
 </AssemblyInfo>
 <AssemblyInfo>
 <AssemblyName>System.Runtime</AssemblyName>
 <AssemblyVersion>4.2.0.0</AssemblyVersion>
 <AssemblyVersion>4.2.1.0</AssemblyVersion>
 <AssemblyVersion>4.2.2.0</AssemblyVersion>
 <AssemblyVersion>5.0.0.0</AssemblyVersion>
 <AssemblyVersion>6.0.0.0</AssemblyVersion>
 <AssemblyVersion>7.0.0.0</AssemblyVersion>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 <AssemblyVersion>9.0.0.0</AssemblyVersion>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Parameters>
 <ParameterName="message"Type="System.String" />
 </Parameters>
 <Docs>
 <paramname="message">A <seecref="T:System.String" /> that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
 <summary>Initializes a new instance of the <seecref="T:System.StackOverflowException" /> class with a specified error message.</summary>
 <remarks>
 <formattype="text/markdown"><![CDATA[

## Remarks 
 The following table shows the initial property values for an instance of <xref:System.StackOverflowException>. 

|Property|Value| 
|--------------|-----------| 
|<xref:System.Exception.InnerException%2A>|A null reference (`Nothing` in Visual Basic).| 
|<xref:System.Exception.Message%2A>|The error message string.| 

]]></format>
 </remarks>
 </Docs>
 </Member>
 <MemberMemberName=".ctor">
 <MemberSignatureLanguage="C#"Value="public StackOverflowException (string? message, Exception? innerException);"FrameworkAlternate="net-10.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netcore-3.0;netcore-3.1" />
 <MemberSignatureLanguage="ILAsm"Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, class System.Exception innerException) cil managed" />
 <MemberSignatureLanguage="DocId"Value="M:System.StackOverflowException.#ctor(System.String,System.Exception)" />
 <MemberSignatureLanguage="VB.NET"Value="Public Sub New (message As String, innerException As Exception)" />
 <MemberSignatureLanguage="F#"Value="new StackOverflowException : string * Exception -&gt; StackOverflowException"Usage="new System.StackOverflowException (message, innerException)" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; StackOverflowException(System::String ^ message, Exception ^ innerException);" />
 <MemberSignatureLanguage="C#"Value="public StackOverflowException (string message, Exception innerException);"FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0;netstandard-2.1" />
 <MemberType>Constructor</MemberType>
 <AssemblyInfo>
 <AssemblyName>mscorlib</AssemblyName>
 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 <AssemblyVersion>2.0.0.0</AssemblyVersion>
 <AssemblyVersion>2.0.5.0</AssemblyVersion>
 <AssemblyVersion>4.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <AssemblyInfo>
 <AssemblyName>netstandard</AssemblyName>
 <AssemblyVersion>2.0.0.0</AssemblyVersion>
 <AssemblyVersion>2.1.0.0</AssemblyVersion>
 </AssemblyInfo>
 <AssemblyInfo>
 <AssemblyName>System.Runtime</AssemblyName>
 <AssemblyVersion>4.2.0.0</AssemblyVersion>
 <AssemblyVersion>4.2.1.0</AssemblyVersion>
 <AssemblyVersion>4.2.2.0</AssemblyVersion>
 <AssemblyVersion>5.0.0.0</AssemblyVersion>
 <AssemblyVersion>6.0.0.0</AssemblyVersion>
 <AssemblyVersion>7.0.0.0</AssemblyVersion>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 <AssemblyVersion>9.0.0.0</AssemblyVersion>
 <AssemblyVersion>10.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Parameters>
 <ParameterName="message"Type="System.String" />
 <ParameterName="innerException"Type="System.Exception" />
 </Parameters>
 <Docs>
 <paramname="message">The error message that explains the reason for the exception.</param>
 <paramname="innerException">The exception that is the cause of the current exception. If the <paramrefname="innerException" /> parameter is not a null reference (<seelangword="Nothing" /> in Visual Basic), the current exception is raised in a <seelangword="catch" /> block that handles the inner exception.</param>
 <summary>Initializes a new instance of the <seecref="T:System.StackOverflowException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
 <remarks>
 <formattype="text/markdown"><![CDATA[

## Remarks 
 An exception that is thrown as a direct result of a previous exception can include a reference to the previous exception in the <xref:System.Exception.InnerException%2A> property. The <xref:System.Exception.InnerException%2A> property returns the same value that is passed into the constructor, or a null reference (`Nothing` in Visual Basic) if the <xref:System.Exception.InnerException%2A> property does not supply the inner exception value to the constructor. 

 The following table shows the initial property values for an instance of <xref:System.StackOverflowException>. 

|Property|Value| 
|--------------|-----------| 
|<xref:System.Exception.InnerException%2A>|The inner exception reference.| 
|<xref:System.Exception.Message%2A>|The error message string.| 

]]></format>
 </remarks>
 <altmembercref="T:System.Exception" />
 <relatedtype="Article"href="/dotnet/standard/exceptions/">Handling and Throwing Exceptions</related>
 </Docs>
 </Member>
 </Members>
</Type>