SDL::Environment Struct Reference

A thread-safe set of environment variables. More...

Inheritance diagram for SDL::Environment:

Public Member Functions
constexpr	Environment (EnvironmentRaw resource) noexcept
	Constructs from raw Environment.
constexpr	Environment (const Environment &other)=delete
	Copy constructor.
constexpr	Environment (Environment &&other) noexcept
	Move constructor.
constexpr	Environment (const EnvironmentRef &other)=delete
constexpr	Environment (EnvironmentRef &&other)=delete
	Environment (bool populated)
	Create a set of environment variables.
	~Environment ()
	Destructor.
constexpr Environment &	operator= (Environment &&other) noexcept
	Assignment operator.
Environment &	operator= (const Environment &other)=delete
	Assignment operator.
void	Destroy ()
	Destroy a set of environment variables.
const char *	GetVariable (StringParam name)
	Get the value of a variable in the environment.
OwnArray< char * >	GetVariables ()
	Get all variables in the environment.
Uint64	GetVariableCount ()
	Get the Variables count.
void	SetVariable (StringParam name, StringParam value, bool overwrite)
	Set the value of a variable in the environment.
void	UnsetVariable (StringParam name)
	Clear a variable from the environment.
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBase (std::nullptr_t=nullptr)
	Constructs null/invalid.
Public Member Functions inherited from SDL::ResourceBase< EnvironmentRaw >
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBase &other) const=default
	Comparison.
constexpr RawConstPointer	operator-> () const noexcept
	member access to underlying resource pointer.
constexpr RawPointer	get () const noexcept
	Retrieves underlying resource pointer.
constexpr RawPointer	release () noexcept
	Retrieves underlying resource pointer and clear this.

Additional Inherited Members
Public Types inherited from SDL::ResourceBase< EnvironmentRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.

Detailed Description

A thread-safe set of environment variables.

Since

This struct is available since SDL 3.2.0.

Category:

Resource

See also

GetEnvironment

CreateEnvironment

Environment.GetVariable

Environment.GetVariables

Environment.SetVariable

Environment.UnsetVariable

Environment.Destroy

Constructor & Destructor Documentation

Environment()

SDL::Environment::Environment ( EnvironmentRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw Environment.

Parameters

resource

a EnvironmentRaw to be wrapped.

This assumes the ownership, call release() if you need to take back.

Member Function Documentation

GetVariableCount()

Uint64 SDL::Environment::GetVariableCount ( )

inline

Get the Variables count.

Returns

the number of existing environment variables

This might be slow.

---

The documentation for this struct was generated from the following file:

• SDL3pp/SDL3pp_stdinc.h