~ubuntu-branches/ubuntu/utopic/libunwind/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/unw_strerror.tex

  • Committer: Bazaar Package Importer
  • Author(s): Matthieu Delahaye
  • Date: 2005-04-22 11:12:14 UTC
  • mto: (4.1.1 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20050422111214-0m74olipxly1ra8a
Tags: upstream-0.98.5
ImportĀ upstreamĀ versionĀ 0.98.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
\documentclass{article}
 
2
\usepackage[fancyhdr,pdf]{latex2man}
 
3
 
 
4
\input{common.tex}
 
5
 
 
6
\begin{document}
 
7
 
 
8
\begin{Name}{3}{unw\_strerror}{Thomas Hallgren}{Programming Library}{unw\_strerror}unw\_strerror -- get text corresponding to error code
 
9
\end{Name}
 
10
 
 
11
\section{Synopsis}
 
12
 
 
13
\File{\#include $<$libunwind.h$>$}\\
 
14
 
 
15
\Type{const char *} \Func{unw\_strerror}(\Type{int} \Var{err\_code});\\
 
16
 
 
17
\section{Description}
 
18
 
 
19
The \Func{unw\_strerror}() routine maps the (negative) \Var{err\_code}
 
20
to a corresponding text message and returns it.
 
21
 
 
22
\section{Return Value}
 
23
 
 
24
The message that corresponds to \Var{err\_code} or, if the
 
25
\Var{err\_code} has no corresponding message, the text "invalid error
 
26
code".
 
27
 
 
28
\section{Thread and Signal Safety}
 
29
 
 
30
\Func{unw\_strerror}() is thread-safe as well as safe to use
 
31
from a signal handler.
 
32
 
 
33
\section{Author}
 
34
 
 
35
\noindent
 
36
Thomas Hallgren\\
 
37
BEA Systems\\
 
38
Stockholm, Sweden\\
 
39
Email: \Email{thallgre@bea.com}\\
 
40
\LatexManEnd
 
41
 
 
42
\end{document}