Class

StackOverFlowException

---

Description

Occurs when the calling chain becomes too long.

Properties

Name	Type	Read-Only	Shared
ErrorNumber	Integer
Message	String

Methods

Name	Parameters	Returns	Shared
Constructor	message As String = "", errorCode As Integer = 0
Stack		String()
StackFrames		StackFrame()

Property descriptions

---

StackOverFlowException.ErrorNumber

ErrorNumber As Integer

Used to contain an error number that describes the runtime error.

---

StackOverFlowException.Message

Message As String

Used to contain descriptive text to display when the runtime exception is encountered.

Method descriptions

---

StackOverFlowException.Constructor

Constructor(message As String = "", errorCode As Integer = 0)

Note

Constructors are special methods called when you create an object with the New keyword and pass in the parameters above.

Used to raise your own RuntimeException with a message and optional error code.

---

StackOverFlowException.Stack

Stack As String()

Returns a String array that contains a list of all of the methods in the stack from the main entrypoint to the point at which the exception was invoked.

The stack contains all the method names up and including the current method name.

This feature only works if the IncludeFunctionNames property on the App object is selected in the Shared Build Settings.

In addition to your own method calls, you will also see framework method calls, but these may not always be completely accurate due to insufficient symbols for the OS to resolve.

---

StackOverFlowException.StackFrames

StackFrames As StackFrame()

Returns an array containing the stack when the exception was first raised.

Notes

A StackOverFlowException occurs when the stack overflows. This happens when the calling chain gets too long. This can easily happen when your code makes a recursive call without providing a way to terminate the recursion-or the condition that terminates the recursive call takes too many calls to occur.

Sample code

The following method calls itself until the stack overflows:

Function Square (value As Integer) As Integer
  Return Square(value)
End Function

---

You can handle the function with the following simple Exception handler:

Function Square (value As Integer) As Integer
  Return Square(value)

Exception err
  If err IsA StackOverflowException Then
    MessageBox("The stack has overflowed!")
  End If

Compatibility

All project types on all supported operating systems.

See also

RuntimeException parent class; RuntimeException class; Function, Raise, Sub statements, Nil datatype; Exception, Try statements.