lib/libpthread/pthread_condattr.3

   1 .\" $NetBSD: pthread_condattr.3,v 1.3 2005/06/17 18:07:06 peter Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  14 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  15 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23 .\" POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
  26 .\" All rights reserved.
  27 .\"
  28 .\" Redistribution and use in source and binary forms, with or without
  29 .\" modification, are permitted provided that the following conditions
  30 .\" are met:
  31 .\" 1. Redistributions of source code must retain the above copyright
  32 .\"    notice(s), this list of conditions and the following disclaimer as
  33 .\"    the first lines of this file unmodified other than the possible
  34 .\"    addition of one or more copyright notices.
  35 .\" 2. Redistributions in binary form must reproduce the above copyright
  36 .\"    notice(s), this list of conditions and the following disclaimer in
  37 .\"    the documentation and/or other materials provided with the
  38 .\"    distribution.
  39 .\"
  40 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  41 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  44 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  45 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  46 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  47 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  48 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  49 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  50 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  51 .\"
  52 .\" $FreeBSD: src/lib/libpthread/man/pthread_condattr.3,v 1.10 2002/09/16 19:29:28 mini Exp $
  53 .Dd January 30, 2003
  54 .Dt PTHREAD_CONDATTR 3
  55 .Os
  56 .Sh NAME
  57 .Nm pthread_condattr_init ,
  58 .Nm pthread_condattr_destroy
  59 .Nd condition attribute operations
  60 .Sh LIBRARY
  61 .Lb libpthread
  62 .Sh SYNOPSIS
  63 .In pthread.h
  64 .Ft int
  65 .Fn pthread_condattr_init "pthread_condattr_t *attr"
  66 .Ft int
  67 .Fn pthread_condattr_destroy "pthread_condattr_t *attr"
  68 .Sh DESCRIPTION
  69 Condition attribute objects are used to specify parameters to
  70 .Fn pthread_cond_init .
  71 The
  72 .Fn pthread_condattr_init
  73 function initializes a condition attribute object with the default attributes.
  74 .Pp
  75 The
  76 .Fn pthread_condattr_destroy
  77 function destroys a condition attribute object.
  78 .Sh RETURN VALUES
  79 If successful, these functions return 0.
  80 Otherwise, an error number is returned to indicate the error.
  81 .Sh ERRORS
  82 .Fn pthread_condattr_init
  83 shall fail if:
  84 .Bl -tag -width Er
  85 .It Bq Er ENOMEM
  86 Insufficient memory exists to initialize the condition attribute object.
  87 .El
  88 .Pp
  89 .Fn pthread_condattr_destroy
  90 may fail if:
  91 .Bl -tag -width Er
  92 .It Bq Er EINVAL
  93 The value specified by
  94 .Fa attr
  95 is invalid.
  96 .El
  97 .Sh SEE ALSO
  98 .Xr pthread_cond_init 3
  99 .Sh STANDARDS
 100 .Fn pthread_condattr_init
 101 and
 102 .Fn pthread_condattr_destroy
 103 conform to
 104 .St -p1003.1-96 .