home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_SemWait.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.0 KB  |  63 lines
  1. <!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
  2. <!-- available at http://polyglotman.sourceforge.net/ -->
  3.  
  4. <html>
  5. <head>
  6. <title>"SDL_SemWait"("3") manual page</title>
  7. </head>
  8. <body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
  9. <a href='#toc'>Table of Contents</a><p>
  10.  
  11. <h2><a name='sect0' href='#toc0'>Name</a></h2>
  12. SDL_SemWait- Lock a semaphore and suspend the thread if the semaphore
  13. value is zero. 
  14. <h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
  15. <p>
  16. <b>#include "SDL.h" #include "SDL_thread.h" <p>
  17. </b><b>int <b>SDL_SemWait</b></b>(<b>SDL_sem
  18. *sem</b>); 
  19. <h2><a name='sect2' href='#toc2'>Description</a></h2>
  20. <p>
  21. <b>SDL_SemWait()</b> suspends the calling thread until either
  22. the semaphore pointed to by <b>sem</b> has a positive value, the call is interrupted
  23. by a signal or error. If the call is successful it will atomically decrement
  24. the semaphore value. <p>
  25. After <b>SDL_SemWait()</b> is successful, the semaphore can
  26. be released and its count atomically incremented by a successful call to
  27. <i>SDL_SemPost</i>. 
  28. <h2><a name='sect3' href='#toc3'>Return Value</a></h2>
  29. <p>
  30. Returns <b>0</b> if successful or <b>-1</b> if there was an error
  31. (leaving the semaphore unchanged). 
  32. <h2><a name='sect4' href='#toc4'>Examples</a></h2>
  33. <p>
  34. <p>
  35. <br>
  36. <pre>CWif (SDL_SemWait(my_sem) == -1) {
  37.         return WAIT_FAILED;
  38. }
  39. ...
  40. SDL_SemPost(my_sem);
  41. </pre><p>
  42.  
  43. <h2><a name='sect5' href='#toc5'>See Also</a></h2>
  44. <p>
  45. <i><b>SDL_CreateSemaphore</b></i>, <i><b>SDL_DestroySemaphore</b></i>, <i><b>SDL_SemTryWait</b></i>, <i><b>SDL_SemWaitTimeout</b></i>,
  46. <i><b>SDL_SemPost</b></i>, <i><b>SDL_SemValue</b></i> 
  47. <!--
  48.   
  49.  <p>
  50.  
  51. <hr><p>
  52. <a name='toc'><b>Table of Contents</b></a><p>
  53. <ul>
  54. <li><a name='toc0' href='#sect0'>Name</a></li>
  55. <li><a name='toc1' href='#sect1'>Synopsis</a></li>
  56. <li><a name='toc2' href='#sect2'>Description</a></li>
  57. <li><a name='toc3' href='#sect3'>Return Value</a></li>
  58. <li><a name='toc4' href='#sect4'>Examples</a></li>
  59. <li><a name='toc5' href='#sect5'>See Also</a></li>
  60. </ul>
  61. </body>
  62. </html>
  63.