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

SDL_GetEnvironment

Get the process environment.

Header File

Defined in <SDL3/SDL_stdinc.h>

Syntax

SDL_Environment * SDL_GetEnvironment(void);

Return Value

(SDL_Environment *) Returns a pointer to the environment for the process or NULL on failure; call SDL_GetError() for more information.

Remarks

This is initialized at application start and is not affected by setenv() and unsetenv() calls after that point. Use SDL_SetEnvironmentVariable() and SDL_UnsetEnvironmentVariable() if you want to modify this environment, or SDL_setenv_unsafe() or SDL_unsetenv_unsafe() if you want changes to persist in the C runtime environment after SDL_Quit().

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_GetEnvironmentVariable
• SDL_GetEnvironmentVariables
• SDL_SetEnvironmentVariable
• 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.