xref: /openbsd-src/lib/libpthread/man/pthread_attr_setstackaddr.3 (revision 47911bd667ac77dc523b8a13ef40b012dbffa741)
1.\" $OpenBSD: pthread_attr_setstackaddr.3,v 1.4 2002/05/01 08:03:30 mpech Exp $
2.\" Manual page derived from TOG's UNIX98 documentation.
3.Dd January 6, 2000
4.Dt PTHREAD_ATTR_SETSTACKADDR 3
5.Os
6.Sh NAME
7.Nm pthread_attr_setstackaddr ,
8.Nm pthread_attr_getstackaddr
9.Nd set and get stackaddr attribute
10.Sh SYNOPSIS
11.Fd #include <pthread.h>
12.Ft int
13.Fn pthread_attr_setstackaddr "pthread_attr_t *attr" "void *stackaddr"
14.Ft int
15.Fn pthread_attr_getstackaddr "pthread_attr_t *attr" "void **stackaddr"
16.Sh DESCRIPTION
17The functions
18.Fn pthread_attr_setstackaddr
19and
20.Fn pthread_attr_getstackaddr ,
21respectively, set and get the thread
22creation
23.Va stackaddr
24attribute in the
25.Fa attr
26object.
27.Pp
28The
29.Va stackaddr
30attribute specifies the location of storage to be
31used for the created thread's stack.
32The size of the storage is at least
33.Dv PTHREAD_STACK_MIN .
34.Sh RETURN VALUE
35Upon successful completion,
36.Fn pthread_attr_setstackaddr
37and
38.Fn pthread_attr_getstackaddr
39return a value of 0. Otherwise, an error
40number is returned to indicate the error.
41.Pp
42The
43.Fn pthread_attr_getstackaddr
44function stores the
45.Va stackaddr
46attribute value in
47.Fa stackaddr
48if successful.
49.Sh ERRORS
50No errors are defined.
51.Pp
52These functions will not return an error code of
53.Bq Er EINTR .
54.Sh SEE ALSO
55.Xr pthread_attr_init 3 ,
56.Xr pthread_attr_setdetachstate 3 ,
57.Xr pthread_attr_setstacksize 3 ,
58.Xr pthread_create 3 ,
59.Xr pthreads 3
60.Sh STANDARDS
61.Fn pthread_create
62conforms to ISO/IEC 9945-1 ANSI/IEEE
63.Pq Dq Tn POSIX
64Std 1003.1 Second Edition 1996-07-12.
65