xref: /netbsd/lib/libc/sys/_lwp_getname.2 (revision 6550d01e)
1.\"     $NetBSD: _lwp_getname.2,v 1.2 2009/05/18 14:49:35 wiz 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 _LWP_GETNAME 2
30.Os
31.Sh NAME
32.Nm _lwp_getname
33.Nd get descriptive name of an LWP
34.\" ------------------------------------------------------------
35.Sh LIBRARY
36.Lb libc
37.\" ------------------------------------------------------------
38.Sh SYNOPSIS
39.In lwp.h
40.Ft int
41.Fn _lwp_getname "lwpid_t target" "char *name" "size_t len"
42.\" ------------------------------------------------------------
43.Sh DESCRIPTION
44.Fn _lwp_getname
45gets the descriptive name of the LWP.
46It takes the following arguments.
47.Bl -tag -width target
48.It Fa target
49The LWP whose descriptive name will be obtained.
50.It Fa name
51The buffer to be filled with the descriptive name of the LWP.
52.It Fa len
53The size of the buffer
54.Fa name
55in bytes.
56.El
57.\" ------------------------------------------------------------
58.Sh RETURN VALUES
59.Fn _lwp_getname
60returns 0 on success.
61Otherwise, \-1 is returned and
62.Va errno
63is set to indicate the error.
64.\" ------------------------------------------------------------
65.\".Sh ERRORS
66.\" ------------------------------------------------------------
67.Sh SEE ALSO
68.Xr ps 1 ,
69.Xr top 1 ,
70.Xr _lwp_setname 2 ,
71.Xr errno 2
72