lib/libpthread/pthread_mutexattr_getkind_np.3

   1 .\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man3/pthread_mutexattr_getkind_np.3,v 1.7 2007/10/22 10:08:00 ru Exp $
  26 .\" $DragonFly: src/lib/libc_r/man/pthread_mutexattr_getkind_np.3,v 1.3 2006/04/08 20:55:59 swildner Exp $
  27 .\"
  28 .Dd July 10, 2009
  29 .Dt PTHREAD_MUTEXATTR_GETKIND_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm pthread_mutexattr_getkind_np ,
  33 .Nm pthread_mutexattr_setkind_np
  34 .Nd mutex attribute operations (legacy)
  35 .Sh LIBRARY
  36 .Lb libpthread
  37 .Sh SYNOPSIS
  38 .In pthread.h
  39 .In pthread_np.h
  40 .Ft int
  41 .Fn pthread_mutexattr_getkind_np "pthread_mutexattr_t attr"
  42 .Ft int
  43 .Fn pthread_mutexattr_setkind_np "pthread_mutexattr_t *attr" "int kind"
  44 .Sh DESCRIPTION
  45 .Bf -symbolic
  46 These functions are deprecated and non-portable implementation of
  47 the mutex type manipulation.
  48 .Ef
  49 .Pp
  50 It is recommended to use the
  51 .Xr pthread_mutexattr_gettype 3
  52 and
  53 .Xr pthread_mutexattr_settype 3
  54 functions instead.
  55 .Sh RETURN VALUES
  56 The
  57 .Fn pthread_mutexattr_getkind_np
  58 function returns a positive value representing the
  59 .Dq kind
  60 of the mutex attribute
  61 .Fa attr
  62 if successful; otherwise the value \-1 is returned and the global variable
  63 .Va errno
  64 is set to indicate the error.
  65 .Pp
  66 .Rv -std pthread_mutexattr_setkind_np
  67 .Sh ERRORS
  68 The
  69 .Fn pthread_mutexattr_getkind_np
  70 and
  71 .Fn pthread_mutexattr_setkind_np
  72 functions will fail if:
  73 .Bl -tag -width Er
  74 .It Bq Er EINVAL
  75 The value specified by
  76 .Fa attr
  77 is invalid.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr pthread_mutexattr_gettype 3 ,
  81 .Xr pthread_mutexattr_settype 3 ,
  82 .Xr pthread_mutex_destroy 3 ,
  83 .Xr pthread_mutex_init 3