.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_WaitSemaphoreTimeout:
.\"   https://wiki.libsdl.org/SDL_WaitSemaphoreTimeout
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_WaitSemaphoreTimeout
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_WaitSemaphoreTimeout 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_WaitSemaphoreTimeout \- Wait until a semaphore has a positive value and then decrements it\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_WaitSemaphoreTimeout(SDL_Semaphore *sem, Sint32 timeoutMS);
.fi
.SH DESCRIPTION
This function suspends the calling thread until either the semaphore
pointed to by
.BR sem
has a positive value, the call is interrupted by a
signal or error, or the specified time has elapsed\[char46] If the call is
successful it will atomically decrement the semaphore value\[char46]

.SH FUNCTION PARAMETERS
.TP
.I sem
the semaphore to wait on
.TP
.I timeoutMS
the length of the timeout, in milliseconds
.SH RETURN VALUE
Returns 0 if the wait succeeds, 
.BR
.BR SDL_MUTEX_TIMEDOUT
if the wait does not succeed in the allotted time, or a negative error code
on failure; call 
.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_PostSemaphore (3),
.BR SDL_TryWaitSemaphore (3),
.BR SDL_WaitSemaphore (3)