Imported Upstream version 1.1
[platform/upstream/libunwind.git] / doc / unw_regname.man
1 '\" t
2 .\" Manual page created with latex2man on Thu Aug 16 09:44:45 MDT 2007
3 .\" NOTE: This file is generated, DO NOT EDIT.
4 .de Vb
5 .ft CW
6 .nf
7 ..
8 .de Ve
9 .ft R
10
11 .fi
12 ..
13 .TH "UNW\\_REGNAME" "3" "16 August 2007" "Programming Library " "Programming Library "
14 .SH NAME
15 unw_regname
16 \-\- get register name 
17 .PP
18 .SH SYNOPSIS
19
20 .PP
21 #include <libunwind.h>
22 .br
23 .PP
24 const char *unw_regname(unw_regnum_t
25 regnum);
26 .br
27 .PP
28 .SH DESCRIPTION
29
30 .PP
31 The unw_regname()
32 routine returns a printable name for 
33 register regnum\&.
34 If regnum
35 is an invalid or otherwise 
36 unrecognized register number, a string consisting of three question 
37 marks is returned. The returned string is statically allocated and 
38 therefore guaranteed to remain valid until the application terminates. 
39 .PP
40 .SH RETURN VALUE
41
42 .PP
43 The unw_regname()
44 routine cannot fail and always returns a 
45 valid (non\-NULL)
46 string. 
47 .PP
48 .SH THREAD AND SIGNAL SAFETY
49
50 .PP
51 The unw_regname()
52 routine is thread\-safe as well as safe to 
53 use from a signal handler. 
54 .PP
55 .SH SEE ALSO
56
57 .PP
58 libunwind(3)
59 .PP
60 .SH AUTHOR
61
62 .PP
63 David Mosberger\-Tang
64 .br
65 Email: \fBdmosberger@gmail.com\fP
66 .br
67 WWW: \fBhttp://www.nongnu.org/libunwind/\fP\&.
68 .\" NOTE: This file is generated, DO NOT EDIT.