1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 2%% Name: stackframe.tex 3%% Purpose: wxStackFrame documentation 4%% Author: Vadim Zeitlin 5%% Created: 2005-01-19 6%% RCS-ID: $Id: stackframe.tex 32309 2005-02-22 15:09:56Z ABX $ 7%% Copyright: (c) 2005 Vadim Zeitlin 8%% License: wxWindows license 9%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 10 11\section{\class{wxStackFrame}}\label{wxstackframe} 12 13 14wxStackFrame represents a single stack frame, or a single function in the call 15stack, and is used exclusively together with 16\helpref{wxStackWalker}{wxstackwalker}, see there for a more detailed 17discussion. 18 19 20\wxheading{Derived from} 21 22No base class 23 24\wxheading{Include files} 25 26<wx/stackwalk.h> 27 28Only available if \texttt{wxUSE\_STACKWALKER} is $1$, currently only 29implemented for Win32 and Unix versions using recent version of GNU libc. 30 31\wxheading{See also} 32 33\helpref{wxStackWalker}{wxstackwalker} 34 35 36\latexignore{\rtfignore{\wxheading{Members}}} 37 38 39\membersection{wxStackFrame::GetAddress}\label{wxstackframegetaddress} 40 41\constfunc{void*}{GetAddress}{\void} 42 43Return the address of this frame. 44 45 46\membersection{wxStackFrame::GetFileName}\label{wxstackframegetfilename} 47 48\constfunc{wxString}{GetFileName}{\void} 49 50Return the name of the file containing this frame, empty if 51unavailable (typically because debug info is missing). 52 53Use \helpref{HasSourceLocation}{wxstackframehassourcelocation} to check whether 54the file name is available. 55 56 57\membersection{wxStackFrame::GetLevel}\label{wxstackframegetlevel} 58 59\constfunc{size\_t}{GetLevel}{\void} 60 61Get the level of this frame (deepest/innermost one is $0$). 62 63 64\membersection{wxStackFrame::GetLine}\label{wxstackframegetline} 65 66\constfunc{size\_t}{GetLine}{\void} 67 68Return the line number of this frame, $0$ if unavailable. 69 70\wxheading{See also} 71 72\helpref{GetFileName}{wxstackframegetfilename} 73 74 75\membersection{wxStackFrame::GetModule}\label{wxstackframegetmodule} 76 77\constfunc{wxString}{GetModule}{\void} 78 79Get the module this function belongs to (empty if not available). 80 81 82\membersection{wxStackFrame::GetName}\label{wxstackframegetname} 83 84\constfunc{wxString}{GetName}{\void} 85 86Return the unmangled (if possible) name of the function containing this 87frame. 88 89 90\membersection{wxStackFrame::GetOffset}\label{wxstackframegetoffset} 91 92\constfunc{size\_t}{GetOffset}{\void} 93 94Return the return address of this frame. 95 96 97\membersection{wxStackFrame::GetParam}\label{wxstackframegetparam} 98 99\constfunc{bool}{GetParam}{\param{size\_t }{n}, \param{wxString * }{type}, \param{wxString * }{name}, \param{wxString * }{value}} 100 101Get the name, type and value (in text form) of the given parameter. 102Any pointer may be \texttt{NULL} if you're not interested in the corresponding 103value. 104 105Return \true if at least some values could be retrieved. 106 107This function currently is only implemented under Win32 and requires a PDB 108file. 109 110 111\membersection{wxStackFrame::GetParamCount}\label{wxstackframegetparamcount} 112 113\constfunc{size\_t}{GetParamCount}{\void} 114 115Return the number of parameters of this function (may return $0$ if we 116can't retrieve the parameters info even although the function does have 117parameters). 118 119 120\membersection{wxStackFrame::HasSourceLocation}\label{wxstackframehassourcelocation} 121 122\constfunc{bool}{HasSourceLocation}{\void} 123 124Return \true if we have the file name and line number for this frame. 125 126 127