xref: /freebsd/share/man/man3/pthread_attr_get_np.3 (revision 4b2eaea43fec8e8792be611dea204071a10b655a)
1.\" Copyright (c) 2002 Alexey Zelkin <phantom@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd October 26, 2002
28.Dt PTHREAD_ATTR_GET_NP 3
29.Os
30.Sh NAME
31.Nm pthread_attr_get_np
32.Nd get attributes of existent thread
33.Sh LIBRARY
34.Lb libc_r
35.Sh SYNOPSIS
36.In pthread_np.h
37.Ft int
38.Fn pthread_attr_get_np "pthread_t pid" "pthread_attr_t *dst"
39.Sh DESCRIPTION
40The
41.Fn pthread_attr_get_np
42function is used to get existent thread's attributes.
43Value returned as
44.Fa dst
45is supposed to be used in conjunction with
46.Fn pthread_attr_get*
47functions to retrieve individual values from
48.Vt pthread_attr_t
49structure.
50Parameter
51.Fa dst
52should point to allocated memory area big enough to fit this structure.
53It is HIGHLY RECOMMENDED to use
54.Xr pthread_attr_init 3
55function to allocate attribute storage.
56.Sh EXAMPLES
57.Bd -literal
58size_t
59my_thread_stack_size(pthread_t pid)
60{
61    pthread_attr_t attr;
62    size_t size;
63
64    pthread_attr_init(&attr);
65    pthread_attr_get_np(pid, &attr);
66    pthread_attr_getstacksize(&attr, &size);
67    pthread_attr_destroy(&attr);
68    return(size);
69}
70.Ed
71.Sh RETURN VALUES
72If successful,
73.Fn pthread_attr_get_np
74function returns 0.
75Otherwise, an error number is returned to indicate the error.
76.Sh ERRORS
77.Fn pthread_attr_get_np
78will fail if:
79.Bl -tag -width Er
80.It Bq Er EINVAL
81Invalid value for one of given parameters.
82.It Bq Er ESRC
83No thread could be found corresponding to that specified by the given
84thread ID.
85.El
86.Sh SEE ALSO
87.Xr pthread_attr_destroy 3 ,
88.Xr pthread_attr_getdetachstate 3 ,
89.Xr pthread_attr_getinheritsched 3 ,
90.Xr pthread_attr_getschedparam 3 ,
91.Xr pthread_attr_getschedpolicy 3 ,
92.Xr pthread_attr_getscope 3 ,
93.Xr pthread_attr_getstackaddr 3 ,
94.Xr pthread_attr_getstacksize 3 ,
95.Xr pthread_attr_init 3
96