doc/unw_regname.tex

   1 \documentclass{article}
   2 \usepackage[fancyhdr,pdf]{latex2man}
   3
   4 \input{common.tex}
   5
   6 \begin{document}
   7
   8 \begin{Name}{3}{unw\_regname}{David Mosberger-Tang}{Programming Library}{unw\_regname}unw\_regname -- get register name
   9 \end{Name}
  10
  11 \section{Synopsis}
  12
  13 \File{\#include $<$libunwind.h$>$}\\
  14
  15 \Type{const char~*}\Func{unw\_regname}(\Type{unw\_regnum\_t} \Var{regnum});\\
  16
  17 \section{Description}
  18
  19 The \Func{unw\_regname}() routine returns a printable name for
  20 register \Var{regnum}.  If \Var{regnum} is an invalid or otherwise
  21 unrecognized register number, a string consisting of three question
  22 marks is returned.  The returned string is statically allocated and
  23 therefore guaranteed to remain valid until the application terminates.
  24
  25 \section{Return Value}
  26
  27 The \Func{unw\_regname}() routine cannot fail and always returns a
  28 valid (non-\Const{NULL}) string.
  29
  30 \section{Thread and Signal Safety}
  31
  32 The \Func{unw\_regname}() routine is thread-safe as well as safe to
  33 use from a signal handler.
  34
  35 \section{See Also}
  36
  37 \SeeAlso{libunwind(3)}
  38
  39 \section{Author}
  40
  41 \noindent
  42 David Mosberger-Tang\\
  43 Email: \Email{dmosberger@gmail.com}\\
  44 WWW: \URL{http://www.nongnu.org/libunwind/}.
  45 \LatexManEnd
  46
  47 \end{document}