SDL_SetStringProperty(3)

SDL_SetStringProperty3

Set a string property in a group of properties.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_properties.h

Overview

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

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 true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.