NetBSD/lib/libpthread/pthread_getname_np.3

.\"     $NetBSD: pthread_getname_np.3,v 1.3 2010/07/07 09:54:07 wiz Exp $
.\"
.\" Copyright (c)2007 YAMAMOTO Takashi,
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" ------------------------------------------------------------
.Dd July 7, 2010
.Dt PTHREAD_GETNAME_NP 3
.Os
.Sh NAME
.Nm pthread_getname_np
.Nd set descriptive name of a thread
.\" ------------------------------------------------------------
.Sh LIBRARY
.Lb libpthread
.\" ------------------------------------------------------------
.Sh SYNOPSIS
.In pthread.h
.Ft int
.Fn pthread_getname_np "pthread_t thread" "char *name" "size_t len"
.\" ------------------------------------------------------------
.Sh DESCRIPTION
The
.Fn pthread_getname_np
function obtains the descriptive name of a thread.
It takes the following arguments:
.Bl -tag -width target -offset indent
.It Fa thread
The thread whose descriptive name will be obtained.
.It Fa name
The buffer to be filled with the descriptive name of the thread.
.It Fa len
The size of the buffer
.Fa name
in bytes.
.El
.\" ------------------------------------------------------------
.Sh RETURN VALUES
The
.Fn pthread_getname_np
function returns 0 on success.
Otherwise, an error number is returned to indicate the error.
.\" ------------------------------------------------------------
.Sh COMPATIBILITY
The
.Fn pthread_getname_np
function is a non-standard extension.
.\" ------------------------------------------------------------
.Sh ERRORS
The
.Fn pthread_getname_np
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid parameter.
.It Bq Er ESRCH
Non-existent
.Fa thread .
.El
.Sh SEE ALSO
.Xr pthread_attr_get_np 3 ,
.Xr pthread_setname_np 3