(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetStringProperty

Set a string property in a group of properties.

Header File

Defined in <SDL3/SDL_properties.h>

Syntax

bool SDL_SetStringProperty(SDL_PropertiesID props, const char *name, const char *value);

Function Parameters

SDL_PropertiesID	props	the properties to modify.
const char *	name	the name of the property to modify.
const char *	value	the new value of the property, or NULL to delete the property.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

This function makes a copy of the string; the caller does not have to preserve the data after this call completes.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetStringProperty

---

CategoryAPI, CategoryAPIFunction, CategoryProperties

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.