doc/unw_is_fpreg.tex

   1 \documentclass{article}
   2 \usepackage[fancyhdr,pdf]{latex2man}
   3
   4 \input{common.tex}
   5
   6 \begin{document}
   7
   8 \begin{Name}{3}{unw\_is\_fpreg}{David Mosberger-Tang}{Programming Library}{unw\_is\_fpreg}unw\_is\_fpreg -- check if a register is a floating-point register
   9 \end{Name}
  10
  11 \section{Synopsis}
  12
  13 \File{\#include $<$libunwind.h$>$}\\
  14
  15 \Type{int} \Func{unw\_is\_fpreg}(\Type{unw\_regnum\_t} \Var{reg});\\
  16
  17 \section{Description}
  18
  19 The \Func{unw\_is\_fpreg}() routine checks whether register number
  20 \Var{reg} is a floating-point register.
  21
  22 This routine is normally implemented as a macro and applications
  23 should not attempt to take its address.
  24
  25 \section{Return Value}
  26
  27 The \Func{unw\_is\_fpreg}() routine returns a non-zero value if
  28 \Var{reg} is a floating-point register.  Otherwise, it returns a value
  29 of 0.
  30
  31 \section{Thread and Signal Safety}
  32
  33 \Func{unw\_is\_fpreg}() is thread-safe as well as safe to use
  34 from a signal handler.
  35
  36 \section{See Also}
  37
  38 \SeeAlso{libunwind(3)},
  39 \SeeAlso{unw\_get\_reg(3)},
  40 \SeeAlso{unw\_set\_reg(3)},
  41 \SeeAlso{unw\_get\_fpreg(3)},
  42 \SeeAlso{unw\_set\_fpreg(3)}
  43
  44 \section{Author}
  45
  46 \noindent
  47 David Mosberger-Tang\\
  48 Email: \Email{dmosberger@gmail.com}\\
  49 WWW: \URL{http://www.nongnu.org/libunwind/}.
  50 \LatexManEnd
  51
  52 \end{document}