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