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