(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_SetStringProperty

Set a string property on a set of properties.

Header File

Defined in <SDL3/SDL_properties.h>

Syntax

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

Function Parameters

props the properties to modify
name the name of the property to modify
value the new value of the property, or NULL to delete the property

Return Value

Returns 0 on success or a negative error code 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.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryProperties