Function SDL_SetEnvironmentVariable

pub unsafe extern "C" fn SDL_SetEnvironmentVariable(
    env: *mut SDL_Environment,
    name: *const i8,
    value: *const i8,
    overwrite: bool,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Set the value of a variable in the environment.

§Parameters

  • env: the environment to modify.
  • name: the name of the variable to set.
  • value: the value of the variable to set.
  • overwrite: true to overwrite the variable if it exists, false to return success without setting the variable if it already exists.

§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