SDL_GetEnvironment

Get the process environment.

Header File

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

Note that on Windows, the variable names pulled in from the system at startup have their ASCII values uppercased, to match what most platforms expect even though the Windows system environment table is case-insensitive. Once those uppercased variable names are in an SDL_Environment, SDL treats them as case-sensitive.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.