/share/man/man3/pthread_rwlock_destroy.3

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 83 lines · 83 code · 0 blank · 0 comment · 0 complexity · 2c63b0206ffcce47dac7397810616eaf MD5 · raw file 

    

  1. .\" Copyright (c) 1998 Alex Nash
    2. 

  2. .\" All rights reserved.
    3. 

  3. .\"
    4. 

  4. .\" Redistribution and use in source and binary forms, with or without
    5. 

  5. .\" modification, are permitted provided that the following conditions
    6. 

  6. .\" are met:
    7. 

  7. .\" 1. Redistributions of source code must retain the above copyright
    8. 

  8. .\"    notice, this list of conditions and the following disclaimer.
    9. 

  9. .\" 2. Redistributions in binary form must reproduce the above copyright
    10. 

  10. .\"    notice, this list of conditions and the following disclaimer in the
    11. 

  11. .\"    documentation and/or other materials provided with the distribution.
    12. 

  12. .\"
    13. 

  13. .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    14. 

  14. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    15. 

  15. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    16. 

  16. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    17. 

  17. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    18. 

  18. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    19. 

  19. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    20. 

  20. .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    21. 

  21. .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    22. 

  22. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    23. 

  23. .\" SUCH DAMAGE.
    24. 

  24. .\"
    25. 

  25. .\" $FreeBSD$
    26. 

  26. .\"
    27. 

  27. .Dd August 4, 1998
    28. 

  28. .Dt PTHREAD_RWLOCK_DESTROY 3
    29. 

  29. .Os
    30. 

  30. .Sh NAME
    31. 

  31. .Nm pthread_rwlock_destroy
    32. 

  32. .Nd destroy a read/write lock
    33. 

  33. .Sh LIBRARY
    34. 

  34. .Lb libpthread
    35. 

  35. .Sh SYNOPSIS
    36. 

  36. .In pthread.h
    37. 

  37. .Ft int
    38. 

  38. .Fn pthread_rwlock_destroy "pthread_rwlock_t *lock"
    39. 

  39. .Sh DESCRIPTION
    40. 

  40. The
    41. 

  41. .Fn pthread_rwlock_destroy
    42. 

  42. function is used to destroy a read/write lock previously created with
    43. 

  43. .Fn pthread_rwlock_init .
    44. 

  44. .Sh RETURN VALUES
    45. 

  45. If successful, the
    46. 

  46. .Fn pthread_rwlock_destroy
    47. 

  47. function will return zero.
    48. 

  48. Otherwise an error number will be returned
    49. 

  49. to indicate the error.
    50. 

  50. .Sh ERRORS
    51. 

  51. The
    52. 

  52. .Fn pthread_rwlock_destroy
    53. 

  53. function will fail if:
    54. 

  54. .Bl -tag -width Er
    55. 

  55. .It Bq Er EPERM
    56. 

  56. The caller does not have the privilege to perform the operation.
    57. 

  57. .El
    58. 

  58. .Pp
    59. 

  59. The
    60. 

  60. .Fn pthread_rwlock_destroy
    61. 

  61. function may fail if:
    62. 

  62. .Bl -tag -width Er
    63. 

  63. .It Bq Er EBUSY
    64. 

  64. The system has detected an attempt to destroy the object referenced by
    65. 

  65. .Fa lock
    66. 

  66. while it is locked.
    67. 

  67. .It Bq Er EINVAL
    68. 

  68. The value specified by
    69. 

  69. .Fa lock
    70. 

  70. is invalid.
    71. 

  71. .El
    72. 

  72. .Sh SEE ALSO
    73. 

  73. .Xr pthread_rwlock_init 3
    74. 

  74. .Sh STANDARDS
    75. 

  75. The
    76. 

  76. .Fn pthread_rwlock_destroy
    77. 

  77. function is expected to conform to
    78. 

  78. .St -susv2 .
    79. 

  79. .Sh HISTORY
    80. 

  80. The
    81. 

  81. .Fn pthread_rwlock_destroy
    82. 

  82. function first appeared in
    83. 

  83. .Fx 3.0 .
    84.