doc/unw_get_accessors.tex

   1 \documentclass{article}
   2 \usepackage[fancyhdr,pdf]{latex2man}
   3
   4 \input{common.tex}
   5
   6 \begin{document}
   7
   8 \begin{Name}{3}{unw\_get\_accessors}{David Mosberger-Tang}{Programming Library}{unw\_get\_accessors}unw\_get\_accessors -- get pointer to accessor call-backs
   9 \end{Name}
  10
  11 \section{Synopsis}
  12
  13 \File{\#include $<$libunwind.h$>$}\\
  14
  15 \Type{unw\_accessors\_t~*}\Func{unw\_get\_accessors}(\Type{unw\_addr\_space\_t~}\Var{as});\\
  16
  17 \section{Description}
  18
  19 The \Func{unw\_get\_accessors}() routine returns a pointer to a
  20 \Type{unw\_accessors\_t} structure, which contains the call-back
  21 routines that were specified when address space \Var{as} was created
  22 (see \Func{unw\_create\_addr\_space}(3)).  The returned pointer is
  23 guaranteed to remain valid until address space \Var{as} is destroyed
  24 by a call to \Func{unw\_destroy\_addr\_space}(3).
  25
  26 Note that \Func{unw\_get\_accessors}() can be used to retrieve the
  27 call-back routines for the local address space
  28 \Var{unw\_local\_addr\_space}.
  29
  30 \section{Return Value}
  31
  32 The \Func{unw\_get\_accessors}() routine cannot fail and always
  33 returns a valid (non-\Const{NULL}) pointer to an
  34 \Type{unw\_accessors\_t} structure.
  35
  36 \section{Thread and Signal Safety}
  37
  38 The \Func{unw\_get\_accessors}() routine is thread-safe as well as
  39 safe to use from a signal handler.
  40
  41 \section{See Also}
  42
  43 \SeeAlso{libunwind(3)},
  44 \SeeAlso{unw\_create\_addr\_space(3)},
  45 \SeeAlso{unw\_destroy\_addr\_space(3)}
  46
  47 \section{Author}
  48
  49 \noindent
  50 David Mosberger-Tang\\
  51 Email: \Email{dmosberger@gmail.com}\\
  52 WWW: \URL{http://www.nongnu.org/libunwind/}.
  53 \LatexManEnd
  54
  55 \end{document}