share/man/man3/pthread_rwlockattr_destroy.3

   1 .\" Copyright (c) 1998 Alex Nash
   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$
  26 .\"
  27 .Dd August 4, 1998
  28 .Dt PTHREAD_RWLOCKATTR_DESTROY 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_rwlockattr_destroy
  32 .Nd destroy a read/write lock
  33 .Sh LIBRARY
  34 .Lb libpthread
  35 .Sh SYNOPSIS
  36 .In pthread.h
  37 .Ft int
  38 .Fn pthread_rwlockattr_destroy "pthread_rwlockattr_t *attr"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn pthread_rwlockattr_destroy
  42 function is used to destroy a read/write lock attribute object
  43 previously created with
  44 .Fn pthread_rwlockattr_init .
  45 .Sh RETURN VALUES
  46 If successful, the
  47 .Fn pthread_rwlockattr_destroy
  48 function will return zero.
  49 Otherwise an error number will be returned
  50 to indicate the error.
  51 .Sh ERRORS
  52 The
  53 .Fn pthread_rwlockattr_destroy
  54 function may fail if:
  55 .Bl -tag -width Er
  56 .It Bq Er EINVAL
  57 The value specified by
  58 .Fa attr
  59 is invalid.
  60 .El
  61 .Sh SEE ALSO
  62 .Xr pthread_rwlockattr_init 3
  63 .Sh STANDARDS
  64 The
  65 .Fn pthread_rwlockattr_destroy
  66 function is expected to conform to
  67 .St -susv2 .
  68 .Sh HISTORY
  69 The
  70 .Fn pthread_rwlockattr_destroy
  71 function first appeared in
  72 .Fx 3.0 .