Initial import
[external/libunwind.git] / doc / unw_get_accessors.man
1 '\" t
2 .\" Manual page created with latex2man on Thu Aug 16 09:44:44 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\\_GET\\_ACCESSORS" "3" "16 August 2007" "Programming Library " "Programming Library "
14 .SH NAME
15 unw_get_accessors
16 \-\- get pointer to accessor call\-backs 
17 .PP
18 .SH SYNOPSIS
19
20 .PP
21 #include <libunwind.h>
22 .br
23 .PP
24 unw_accessors_t *unw_get_accessors(unw_addr_space_t as);
25 .br
26 .PP
27 .SH DESCRIPTION
28
29 .PP
30 The unw_get_accessors()
31 routine returns a pointer to a 
32 unw_accessors_t
33 structure, which contains the call\-back 
34 routines that were specified when address space as
35 was created 
36 (see unw_create_addr_space(3)).
37 The returned pointer is 
38 guaranteed to remain valid until address space as
39 is destroyed 
40 by a call to unw_destroy_addr_space(3).
41 .PP
42 Note that unw_get_accessors()
43 can be used to retrieve the 
44 call\-back routines for the local address space 
45 unw_local_addr_space\&.
46 .PP
47 .SH RETURN VALUE
48
49 .PP
50 The unw_get_accessors()
51 routine cannot fail and always 
52 returns a valid (non\-NULL)
53 pointer to an 
54 unw_accessors_t
55 structure. 
56 .PP
57 .SH THREAD AND SIGNAL SAFETY
58
59 .PP
60 The unw_get_accessors()
61 routine is thread\-safe as well as 
62 safe to use from a signal handler. 
63 .PP
64 .SH SEE ALSO
65
66 .PP
67 libunwind(3),
68 unw_create_addr_space(3),
69 unw_destroy_addr_space(3)
70 .PP
71 .SH AUTHOR
72
73 .PP
74 David Mosberger\-Tang
75 .br
76 Email: \fBdmosberger@gmail.com\fP
77 .br
78 WWW: \fBhttp://www.nongnu.org/libunwind/\fP\&.
79 .\" NOTE: This file is generated, DO NOT EDIT.