devela::_dep::sdl3::sys::properties

Function SDL_SetStringProperty

pub unsafe extern "C" fn SDL_SetStringProperty(
    props: u32,
    name: *const i8,
    value: *const i8,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Set a string property in a group of properties.

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

§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.

§See also