Differences between version 2 and previous revision of SDL_SemWaitTimeout(3).
Other diffs: Previous Major Revision, Previous Author, or view the Annotated Edit History
| Newer page: | version 2 | Last edited on Monday, June 3, 2002 6:53:48 pm | by perry | Revert |
| Older page: | version 1 | Last edited on Monday, June 3, 2002 6:53:48 pm | by perry | Revert |
@@ -1,6 +1,6 @@
-SDL_SemWaitTimeout
-!!!SDL_SemWaitTimeout
+SDL_!
SemWaitTimeout
+!!!SDL_!
SemWaitTimeout
NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
@@ -9,23 +9,23 @@
----
!!NAME
-SDL_SemWaitTimeout- Lock a semaphore, but only wait up to a specified maximum time.
+SDL_!
SemWaitTimeout- Lock a semaphore, but only wait up to a specified maximum time.
!!SYNOPSIS
__#include
__
-__int SDL_SemWaitTimeout__(__SDL_sem *sem, Uint32
+__int SDL_!
SemWaitTimeout__(__SDL_sem *sem, Uint32
timeout__);
!!DESCRIPTION
-__SDL_SemWaitTimeout()__ is a varient of
-''SDL_SemWait'' with a maximum timeout value. If the
+__SDL_!
SemWaitTimeout()__ is a varient of
+''SDL_!
SemWait'' with a maximum timeout value. If the
value of the semaphore pointed to by __sem__ is positive
(greater than zero) it will atomically decrement the
semaphore value and return 0, otherwise it will wait up to
__timeout__ milliseconds trying to lock the semaphore.
@@ -33,12 +33,12 @@
platforms it is implemented by polling the semaphore every
millisecond in a busy loop.
-After __SDL_SemWaitTimeout()__ is successful, the
+After __SDL_!
SemWaitTimeout()__ is successful, the
semaphore can be released and its count atomically
incremented by a successful call to
-''SDL_SemPost''.
+''SDL_!
SemPost''.
!!RETURN VALUE
Returns __0__ if the semaphore was successfully locked or
@@ -51,20 +51,20 @@
will be unchanged.
!!EXAMPLES
-res = SDL_SemWaitTimeout(my_sem, WAIT_TIMEOUT_MILLISEC);
+res = SDL_!
SemWaitTimeout(my_sem, WAIT_TIMEOUT_MILLISEC);
if (res == SDL_MUTEX_TIMEOUT) {
return TRY_AGAIN;
}
if (res == -1) {
return WAIT_ERROR;
}
...
-SDL_SemPost(my_sem);
+SDL_!
SemPost(my_sem);
!!SEE ALSO
-__SDL_CreateSemaphore__, __SDL_DestroySemaphore__,
-__SDL_SemWait__, __SDL_SemTryWait__,
-__SDL_SemPost__, __SDL_SemValue__
+__SDL_!
CreateSemaphore__, __SDL_!
DestroySemaphore__,
+__SDL_!
SemWait__, __SDL_!
SemTryWait__,
+__SDL_!
SemPost__, __SDL_!
SemValue__
----
