(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_SemWaitTimeout

Wait until a semaphore has a positive value and then decrements it.

Header File

Defined in SDL_mutex.h, but apps should only #include "SDL.h"!

Syntax

int SDL_SemWaitTimeout(SDL_sem *sem, Uint32 timeout);

Function Parameters

sem	the semaphore to wait on
timeout	the length of the timeout, in milliseconds

Return Value

Returns 0 if the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait does not succeed in the allotted time, or a negative error code on failure; call SDL_GetError() for more information.

Remarks

This function suspends the calling thread until either the semaphore pointed to by sem has a positive value, the call is interrupted by a signal or error, or the specified time has elapsed. If the call is successful it will atomically decrement the semaphore value.

Version

This function is available since SDL 2.0.0.