.\" 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_LockProperties:
.\"   https://wiki.libsdl.org/SDL_LockProperties
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision release-3.2.8-0-gf6864924f
.\" 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_LockProperties
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_LockProperties 3 "SDL 3.2.8" "Simple Directmedia Layer" "SDL3 FUNCTIONS"
.SH NAME
SDL_LockProperties \- Lock a group of properties\[char46]
.SH HEADER FILE
Defined in SDL3/SDL_properties\[char46]h

.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "bool SDL_LockProperties(SDL_PropertiesID props);
.fi
.SH DESCRIPTION
Obtain a multi-threaded lock for these properties\[char46] Other threads will wait
while trying to lock these properties until they are unlocked\[char46] Properties
must be unlocked before they are destroyed\[char46]

The lock is automatically taken when setting individual properties, this
function is only needed when you want to set several properties atomically
or want to guarantee that properties being queried aren't freed in another
thread\[char46]

.SH FUNCTION PARAMETERS
.TP
.I props
the properties to lock\[char46]
.SH RETURN VALUE
Returns true on success or false on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH THREAD SAFETY
It is safe to call this function from any thread\[char46]

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

.SH SEE ALSO
.BR \(bu (3),
.BR SDL_UnlockProperties (3)