/share/man/man3/pthread_mutexattr_getkind_np.3

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 81 lines · 81 code · 0 blank · 0 comment · 0 complexity · 20c91642c934d7050e6fbd6d1fbca4f8 MD5 · raw file 

    

  1. .\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
    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 February 13, 2003
    28. 

  28. .Dt PTHREAD_MUTEXATTR_GETKIND_NP 3
    29. 

  29. .Os
    30. 

  30. .Sh NAME
    31. 

  31. .Nm pthread_mutexattr_getkind_np ,
    32. 

  32. .Nm pthread_mutexattr_setkind_np
    33. 

  33. .Nd mutex attribute operations (legacy)
    34. 

  34. .Sh LIBRARY
    35. 

  35. .Lb libpthread
    36. 

  36. .Sh SYNOPSIS
    37. 

  37. .In pthread_np.h
    38. 

  38. .Ft int
    39. 

  39. .Fn pthread_mutexattr_getkind_np "pthread_mutexattr_t attr"
    40. 

  40. .Ft int
    41. 

  41. .Fn pthread_mutexattr_setkind_np "pthread_mutexattr_t *attr" "int kind"
    42. 

  42. .Sh DESCRIPTION
    43. 

  43. .Bf -symbolic
    44. 

  44. These functions are deprecated and non-portable implementation of
    45. 

  45. the mutex type manipulation.
    46. 

  46. .Ef
    47. 

  47. .Pp
    48. 

  48. It is recommended to use the
    49. 

  49. .Xr pthread_mutexattr_gettype 3
    50. 

  50. and
    51. 

  51. .Xr pthread_mutexattr_settype 3
    52. 

  52. functions instead.
    53. 

  53. .Sh RETURN VALUES
    54. 

  54. The
    55. 

  55. .Fn pthread_mutexattr_getkind_np
    56. 

  56. function returns a positive value representing the
    57. 

  57. .Dq kind
    58. 

  58. of the mutex attribute
    59. 

  59. .Fa attr
    60. 

  60. if successful; otherwise the value \-1 is returned and the global variable
    61. 

  61. .Va errno
    62. 

  62. is set to indicate the error.
    63. 

  63. .Pp
    64. 

  64. .Rv -std pthread_mutexattr_setkind_np
    65. 

  65. .Sh ERRORS
    66. 

  66. The
    67. 

  67. .Fn pthread_mutexattr_getkind_np
    68. 

  68. and
    69. 

  69. .Fn pthread_mutexattr_setkind_np
    70. 

  70. functions will fail if:
    71. 

  71. .Bl -tag -width Er
    72. 

  72. .It Bq Er EINVAL
    73. 

  73. The value specified by
    74. 

  74. .Fa attr
    75. 

  75. is invalid.
    76. 

  76. .El
    77. 

  77. .Sh SEE ALSO
    78. 

  78. .Xr pthread_mutexattr_gettype 3 ,
    79. 

  79. .Xr pthread_mutexattr_settype 3 ,
    80. 

  80. .Xr pthread_mutex_destroy 3 ,
    81. 

  81. .Xr pthread_mutex_init 3
    82.