1.\"     $NetBSD: pthread_getname_np.3,v 1.4 2010/07/09 07:31:01 jruoho 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 July 9, 2010
29.Dt PTHREAD_GETNAME_NP 3
30.Os
31.Sh NAME
32.Nm pthread_getname_np
33.Nd get and set descriptive name of a thread
34.\" ------------------------------------------------------------
35.Sh LIBRARY
36.Lb libpthread
37.\" ------------------------------------------------------------
38.Sh SYNOPSIS
39.In pthread.h
40.Ft int
41.Fn pthread_getname_np "pthread_t thread" "char *name" "size_t len"
42.Ft int
43.Fn pthread_setname_np "pthread_t thread" "const char *name" "void *arg"
44.\" ------------------------------------------------------------
45.Sh DESCRIPTION
46The
47.Fn pthread_getname_np
48function obtains the descriptive name of a thread.
49It takes the following arguments:
50.Bl -tag -width target -offset indent
51.It Fa thread
52The thread whose descriptive name will be obtained.
53.It Fa name
54The buffer to be filled with the descriptive name of the thread.
55.It Fa len
56The size of the buffer
57.Fa name
58in bytes.
59.El
60.Pp
61The
62.Fn pthread_setname_np
63function sets the descriptive name of a thread.
64It takes the following arguments:
65.Bl -tag -width target -offset indent
66.It Fa thread
67The thread whose descriptive name will be set.
68.It Fa name
69The
70.Xr printf 3
71format string to be used to construct the descriptive name of the thread.
72The resulted descriptive name should be shorter than
73.Dv PTHREAD_MAX_NAMELEN_NP .
74.It Fa arg
75The
76.Xr printf 3
77argument used with
78.Fa name .
79.El
80.\" ------------------------------------------------------------
81.Sh RETURN VALUES
82Both functions return 0 on success.
83Otherwise, an error number is returned to indicate the error.
84.\" ------------------------------------------------------------
85.Sh COMPATIBILITY
86Both functions are non-standard extensions.
87.\" ------------------------------------------------------------
88.Sh ERRORS
89Both functions may fail if:
90.Bl -tag -width Er
91.It Bq Er EINVAL
92Invalid parameter.
93.It Bq Er ESRCH
94Non-existent
95.Fa thread .
96.El
97.Pp
98The
99.Fn pthread_setname_np
100function may also fail if:
101.Bl -tag -width Er
102.It Bq Er ENOMEM
103There was insufficient memory for the operation.
104.El
105.Sh SEE ALSO
106.Xr pthread_attr_get_np 3 ,
107.Xr pthread_attr_getname_np 3
108