SDL_WaitThread - Wait for a thread to finish.
Contents
Availability
This function is available since SDL 3.2.0.
Description
Threads that haven't been detached will remain until this function cleans them up. Not doing so is a
resource leak.
Once a thread has been cleaned up through this function, the
SDL_Thread
that references it becomes invalid and should not be referenced again. As such, only one thread may call
SDL_WaitThread () on another.
The return code from the thread function is placed in the area pointed to by status , if status is not
NULL.
You may not wait on a thread that has been used in a call to
SDL_DetachThread (). Use either that function or this one, but not both, or behavior is undefined.
It is safe to pass a NULL thread to this function; it is a no-op.
Note that the thread pointer is freed by this function and is not valid afterward.
Function Parameters
thread the SDL_Thread
pointer that was returned from the SDL_CreateThread () call that started this thread.
status a pointer filled in with the value returned from the thread function by its 'return', or -1 if the
thread has been detached or isn't valid, may be NULL.
Header File
Defined in SDL3/SDL_thread.h
Name
SDL_WaitThread - Wait for a thread to finish.
See Also
•(3), SDL_CreateThread(3), •(3), SDL_DetachThread(3) Simple Directmedia Layer SDL 3.2.10 SDL_WaitThread(3)
Synopsis
#include"SDL3/SDL.h"voidSDL_WaitThread(SDL_Thread*thread,int*status);
