Function SDL_GetStringProperty

pub unsafe extern "C" fn SDL_GetStringProperty(
    props: u32,
    name: *const i8,
    default_value: *const i8,
) -> *const i8

Available on crate feature dep_sdl3 only.

Get a string property from a group of properties.

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

• SDL_GetPropertyType
• SDL_HasProperty
• SDL_SetStringProperty