X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8795498cd9ec480873e88fccbb63b94be3eddb92..e815120e412d91e79c98dd0afac2a1e399f10810:/docs/latex/wx/stackwalker.tex diff --git a/docs/latex/wx/stackwalker.tex b/docs/latex/wx/stackwalker.tex index 1ae6fb487b..90f7eb5c12 100644 --- a/docs/latex/wx/stackwalker.tex +++ b/docs/latex/wx/stackwalker.tex @@ -11,10 +11,10 @@ \section{\class{wxStackWalker}}\label{wxstackwalker} wxStackWalker allows an application to enumerate, or walk, the stack frames (the function callstack). -It is mostly useful in only two situations: +It is mostly useful in only two situations: inside \helpref{wxApp::OnFatalException}{wxapponfatalexception} function to -programmatically get the location of the crash and, in debug builds, in -\helpref{wxApp::OnAssert}{wxapponassert} to report the caller of the failed +programmatically get the location of the crash and, in debug builds, in +\helpref{wxApp::OnAssertFailure}{wxapponassertfailure} to report the caller of the failed assert. wxStackWalker works by repeatedly calling @@ -46,6 +46,10 @@ No base class +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + Only available if \texttt{wxUSE\_STACKWALKER} is $1$, currently only implemented for Win32 and Unix versions using recent version of GNU libc. @@ -82,19 +86,23 @@ This function must be overrided to process the given frame. \membersection{wxStackWalker::Walk}\label{wxstackwalkerwalk} -\func{void}{Walk}{\param{size\_t }{skip = 1}} +\func{void}{Walk}{\param{size\_t }{skip = 1}, \param{size\_t }{maxDepth = 200}} Enumerate stack frames from the current location, skipping the initial number of them (this can be useful when Walk() is called from some known location and you don't want to see the first few frames anyhow; also notice that Walk() frame itself is not included if skip $\ge 1$). +Up to \arg{maxDepth} frames are walked from the innermost to the outermost one. + \membersection{wxStackWalker::WalkFromException}\label{wxstackwalkerwalkfromexception} -\func{void}{WalkFromException}{\void} +\func{void}{WalkFromException}{\param{size\_t }{maxDepth = 200}} Enumerate stack frames from the location of uncaught exception. -This method can only be called from +This method can only be called from \helpref{wxApp::OnFatalException()}{wxapponfatalexception}. +Up to \arg{maxDepth} frames are walked from the innermost to the outermost one. +