Imported Upstream version 1.3.1
[platform/upstream/libunwind.git] / doc / unw_set_cache_size.man
1 '\" t
2 .\" Manual page created with latex2man on Fri Jan 13 08:33:21 PST 2017
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\\_SET\\_CACHE\\_SIZE" "3" "13 January 2017" "Programming Library " "Programming Library "
14 .SH NAME
15 unw_set_cache_size
16 \-\- set unwind cache size 
17 .PP
18 .SH SYNOPSIS
19
20 .PP
21 #include <libunwind.h>
22 .br
23 .PP
24 int
25 unw_set_cache_size(unw_addr_space_t
26 as,
27 size_t
28 size,
29 int
30 flag);
31 .br
32 .PP
33 .SH DESCRIPTION
34
35 .PP
36 The unw_set_cache_size()
37 routine sets the cache size of 
38 address space as
39 to hold at least as many items as given by 
40 argument size\&.
41 It may hold more items as determined by the 
42 implementation. To disable caching, call 
43 unw_set_caching_policy)
44 with a policy of 
45 UNW_CACHE_NONE\&.
46 Flag is currently unused and must be 0. 
47 .PP
48 .SH RETURN VALUE
49
50 .PP
51 On successful completion, unw_set_cache_size()
52 returns 0. 
53 Otherwise the negative value of one of the error\-codes below is 
54 returned. 
55 .PP
56 .SH THREAD AND SIGNAL SAFETY
57
58 .PP
59 unw_set_cache_size()
60 is thread\-safe but \fInot\fP
61 safe 
62 to use from a signal handler. 
63 .PP
64 .SH ERRORS
65
66 .PP
67 .TP
68 UNW_ENOMEM
69  The desired cache size could not be 
70 established because the application is out of memory. 
71 .PP
72 .SH SEE ALSO
73
74 .PP
75 libunwind(3),
76 unw_create_addr_space(3),
77 unw_set_caching_policy(3),
78 unw_flush_cache(3)
79 .PP
80 .SH AUTHOR
81
82 .PP
83 Dave Watson
84 .br
85 Email: \fBdade.watson@gmail.com\fP
86 .br
87 WWW: \fBhttp://www.nongnu.org/libunwind/\fP\&.
88 .\" NOTE: This file is generated, DO NOT EDIT.