SDL_GetStringProperty - Man Page
Get a string property from a group of properties.
Header File
Defined in SDL3/SDL_properties.h
Synopsis
#include "SDL3/SDL.h" const char * SDL_GetStringProperty(SDL_PropertiesID props, const char *name, const char *default_value);
Function Parameters
- props
the properties to query.
- name
the name of the property to query.
- default_value
the default value of the property.
Return Value
Returns the value of the property, or default_value if it is not set or not a string property.
Thread Safety
It is safe to call this function from any thread, although the data returned is not protected and could potentially be freed if you call
SDL_SetStringProperty () or
SDL_ClearProperty () on these properties from another thread. If you need to avoid this, use
SDL_LockProperties () and
SDL_UnlockProperties ().
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_GetPropertyType(3), ·(3), SDL_HasProperty(3), ·(3), SDL_SetStringProperty(3)
Referenced By
SDL_GetPointerProperty(3), SDL_SetStringProperty(3).