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