xref: /netbsd-src/lib/libpthread/pthread_attr_getname_np.3 (revision abb0f93cd77b67f080613360c65701f85e5f5cfe)
1.\"     $NetBSD: pthread_attr_getname_np.3,v 1.1 2007/12/14 21:51:21 yamt Exp $
2.\"
3.\" Copyright (c)2007 YAMAMOTO Takashi,
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" ------------------------------------------------------------
28.Dd December 15, 2007
29.Dt PTHREAD_ATTR_GETNAME_NP 3
30.Os
31.Sh NAME
32.Nm pthread_attr_getname_np
33.Nd set descriptive name of an attribute
34.\" ------------------------------------------------------------
35.Sh LIBRARY
36.Lb libc
37.\" ------------------------------------------------------------
38.Sh SYNOPSIS
39.In pthread.h
40.Ft int
41.Fn pthread_attr_getname_np "const pthread_attr_t attr" "char *name" \
42    "size_t len"
43.\" ------------------------------------------------------------
44.Sh DESCRIPTION
45.Fn pthread_attr_getname_np
46gets the descriptive name of the attribute.
47It takes the following arguments.
48.Bl -tag -width target
49.It Fa attr
50The attribute whose descriptive name will be obtained.
51.It Fa name
52The buffer to be filled with the descriptive name of the attribute.
53.It Fa len
54The size of the buffer
55.Fa name
56in bytes.
57.El
58.\" ------------------------------------------------------------
59.Sh RETURN VALUES
60.Fn pthread_attr_getname_np
61returns 0 on success.
62Otherwise,
63.Fn pthread_attr_getname_np
64returns an error number described in
65.Xr errno 2 .
66.\" ------------------------------------------------------------
67.\".Sh ERRORS
68.\" ------------------------------------------------------------
69.Sh SEE ALSO
70.Xr errno 2 ,
71.Xr pthread_attr_setname_np 3
72