git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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