(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetEnvironmentVariable

Set the value of a variable in the environment.

Header File

Defined in <SDL3/SDL_stdinc.h>

Syntax

bool SDL_SetEnvironmentVariable(SDL_Environment *env, const char *name, const char *value, bool overwrite);

Function Parameters

SDL_Environment *	env	the environment to modify.
const char *	name	the name of the variable to set.
const char *	value	the value of the variable to set.
bool	overwrite	true to overwrite the variable if it exists, false to return success without setting the variable if it already exists.

Return Value

(bool) 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.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetEnvironment
• SDL_CreateEnvironment
• SDL_GetEnvironmentVariable
• SDL_GetEnvironmentVariables
• SDL_UnsetEnvironmentVariable

---

CategoryAPI, CategoryAPIFunction, CategoryStdinc

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.