pthread_mutexattr_setpshared.html 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <HTML>
  3. <HEAD>
  4. <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
  5. <TITLE>&quot;PTHREAD_MUTEXATTR_GETPSHARED&quot;(P) manual page</TITLE>
  6. <META NAME="GENERATOR" CONTENT="OpenOffice.org 1.1.3 (Linux)">
  7. <META NAME="CREATED" CONTENT="20050504;23480600">
  8. <META NAME="CHANGED" CONTENT="20050505;18381800">
  9. <!-- manual page source format generated by PolyglotMan v3.2, -->
  10. <!-- available at http://polyglotman.sourceforge.net/ -->
  11. </HEAD>
  12. <BODY LANG="en-GB" BGCOLOR="#ffffff" DIR="LTR">
  13. <H4>POSIX Threads for Windows – REFERENCE - <A HREF="http://sources.redhat.com/pthreads-win32">Pthreads-w32</A></H4>
  14. <P><A HREF="index.html">Reference Index</A></P>
  15. <P><A HREF="#toc">Table of Contents</A></P>
  16. <H2><A HREF="#toc0" NAME="sect0">Name</A></H2>
  17. <P>pthread_mutexattr_getpshared, pthread_mutexattr_setpshared - get
  18. and set the process-shared attribute
  19. </P>
  20. <H2><A HREF="#toc1" NAME="sect1">Synopsis</A></H2>
  21. <P><B>#include &lt;pthread.h&gt; </B>
  22. </P>
  23. <P><B>int pthread_mutexattr_getpshared(const pthread_mutexattr_t *
  24. restrict</B> <I>attr</I><B>, int *restrict</B> <I>pshared</I><B>);
  25. <BR>int pthread_mutexattr_setpshared(pthread_mutexattr_t *</B><I>attr</I><B>,
  26. int</B> <I>pshared</I><B>); </B>
  27. </P>
  28. <H2><A HREF="#toc2" NAME="sect2">Description</A></H2>
  29. <P>The <B>pthread_mutexattr_getpshared</B> function shall obtain the
  30. value of the <I>process-shared</I> attribute from the attributes
  31. object referenced by <I>attr</I>. The <B>pthread_mutexattr_setpshared</B>
  32. function shall set the <I>process-shared</I> attribute in an
  33. initialized attributes object referenced by <I>attr</I>.
  34. </P>
  35. <P>The <I>process-shared</I> attribute is set to
  36. <B>PTHREAD_PROCESS_SHARED</B> to permit a mutex to be operated upon
  37. by any thread that has access to the memory where the mutex is
  38. allocated, even if the mutex is allocated in memory that is shared by
  39. multiple processes. If the <I>process-shared</I> attribute is
  40. <B>PTHREAD_PROCESS_PRIVATE</B>, the mutex shall only be operated upon
  41. by threads created within the same process as the thread that
  42. initialized the mutex; if threads of differing processes attempt to
  43. operate on such a mutex, the behavior is undefined. The default value
  44. of the attribute shall be <B>PTHREAD_PROCESS_PRIVATE</B>.
  45. </P>
  46. <P><B>Pthreads-w32</B> defines <B>_POSIX_THREAD_PROCESS_SHARED</B> in
  47. pthread.h as -1 to indicate that these routines are implemented but
  48. the process shared option is not supported.</P>
  49. <H2><A HREF="#toc3" NAME="sect3">Return Value</A></H2>
  50. <P>Upon successful completion, <B>pthread_mutexattr_setpshared</B>
  51. shall return zero; otherwise, an error number shall be returned to
  52. indicate the error.
  53. </P>
  54. <P>Upon successful completion, <B>pthread_mutexattr_getpshared</B>
  55. shall return zero and store the value of the <I>process-shared</I>
  56. attribute of <I>attr</I> into the object referenced by the <I>pshared</I>
  57. parameter. Otherwise, an error number shall be returned to indicate
  58. the error.
  59. </P>
  60. <H2><A HREF="#toc4" NAME="sect4">Errors</A></H2>
  61. <P>The <B>pthread_mutexattr_getpshared</B> and
  62. <B>pthread_mutexattr_setpshared</B> functions may fail if:
  63. </P>
  64. <DL>
  65. <DT><B>EINVAL</B>
  66. </DT><DD STYLE="margin-bottom: 0.5cm">
  67. The value specified by <I>attr</I> is invalid.
  68. </DD></DL>
  69. <P>
  70. The <B>pthread_mutexattr_setpshared</B> function may fail if:
  71. </P>
  72. <DL>
  73. <DT><B>EINVAL</B>
  74. </DT><DD STYLE="margin-bottom: 0.5cm">
  75. The new value specified for the attribute is outside the range of
  76. legal values for that attribute.
  77. </DD><DT>
  78. <B>ENOTSUP</B>
  79. </DT><DD STYLE="margin-bottom: 0.5cm">
  80. The new value specified for the attribute is PTHREAD_PROCESS_SHARED.
  81. </DD></DL>
  82. <P>
  83. These functions shall not return an error code of [EINTR].
  84. </P>
  85. <P><I>The following sections are informative.</I>
  86. </P>
  87. <H2><A HREF="#toc5" NAME="sect5">Examples</A></H2>
  88. <P>None.
  89. </P>
  90. <H2><A HREF="#toc6" NAME="sect6">Application Usage</A></H2>
  91. <P>None.
  92. </P>
  93. <H2><A HREF="#toc7" NAME="sect7">Rationale</A></H2>
  94. <P>None.
  95. </P>
  96. <H2><A HREF="#toc8" NAME="sect8">Future Directions</A></H2>
  97. <P>None.
  98. </P>
  99. <H2><A HREF="#toc9" NAME="sect9">See Also</A></H2>
  100. <P><A HREF="pthread_cond_init.html"><B>pthread_cond_destroy</B>(3)</A>
  101. <B>,</B> <A HREF="pthread_create.html"><B>pthread_create</B>(3)</A> <B>,</B>
  102. <A HREF="pthread_mutex_init.html"><B>pthread_mutex_destroy</B>(3)</A>
  103. <B>,</B> <A HREF="pthread_mutexattr_init.html"><B>pthread_mutexattr_destroy</B>(3)</A>
  104. <B>,</B> the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001,
  105. <I>&lt;pthread.h&gt;</I>
  106. </P>
  107. <H2><A HREF="#toc10" NAME="sect10">Copyright</A></H2>
  108. <P>Portions of this text are reprinted and reproduced in electronic
  109. form from IEEE Std 1003.1, 2003 Edition, Standard for Information
  110. Technology -- Portable Operating System Interface (POSIX), The Open
  111. Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the
  112. Institute of Electrical and Electronics Engineers, Inc and The Open
  113. Group. In the event of any discrepancy between this version and the
  114. original IEEE and The Open Group Standard, the original IEEE and The
  115. Open Group Standard is the referee document. The original Standard
  116. can be obtained online at <A HREF="http://www.opengroup.org/unix/online.html">http://www.opengroup.org/unix/online.html</A>
  117. .
  118. </P>
  119. <P>Modified by Ross Johnson for use with <A HREF="http://sources.redhat.com/pthreads-win32">Pthreads-w32</A>.</P>
  120. <HR>
  121. <P><A NAME="toc"></A><B>Table of Contents</B></P>
  122. <UL>
  123. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect0" NAME="toc0">Name</A>
  124. </P>
  125. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect1" NAME="toc1">Synopsis</A>
  126. </P>
  127. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect2" NAME="toc2">Description</A>
  128. </P>
  129. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect3" NAME="toc3">Return
  130. Value</A>
  131. </P>
  132. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect4" NAME="toc4">Errors</A>
  133. </P>
  134. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect5" NAME="toc5">Examples</A>
  135. </P>
  136. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect6" NAME="toc6">Application
  137. Usage</A>
  138. </P>
  139. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect7" NAME="toc7">Rationale</A>
  140. </P>
  141. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect8" NAME="toc8">Future
  142. Directions</A>
  143. </P>
  144. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect9" NAME="toc9">See
  145. Also</A>
  146. </P>
  147. <LI><P><A HREF="#sect10" NAME="toc10">Copyright</A>
  148. </P>
  149. </UL>
  150. </BODY>
  151. </HTML>