SDL::Process Struct Reference

An opaque handle representing a system process. More...

Inheritance diagram for SDL::Process:

Public Member Functions
constexpr	Process (ProcessRaw resource) noexcept
	Constructs from raw Process.
constexpr	Process (Process &&other) noexcept
	Move constructor.
	Process (const char *const *args, bool pipe_stdio)
	Create a new process.
	Process (PropertiesRef props)
	Create a new process with the specified properties.
	~Process ()
	Destructor.
constexpr Process &	operator= (Process &&other) noexcept
	Assignment operator.
Public Member Functions inherited from SDL::ProcessBase
void	Destroy ()
	Destroy a previously created process object.
PropertiesRef	GetProperties () const
	Get the properties associated with a process.
StringResult	Read (int *exitcode=nullptr)
	Read all the output from a process.
template<class T>
OwnArray< T >	ReadAs (int *exitcode=nullptr)
	Read all the output from a process.
IOStreamRef	GetInput ()
	Get the IOStream associated with process standard input.
IOStreamRef	GetOutput ()
	Get the IOStream associated with process standard output.
void	Kill (bool force)
	Stop a process.
bool	Wait (bool block, int *exitcode)
	Wait for a process to finish.
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	ResourceBaseT (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBaseT (std::nullptr_t)
	Constructs null/invalid.
constexpr	ResourceBaseT (const ResourceBaseT &)=default
	Copy constructor.
constexpr	ResourceBaseT (ResourceBaseT &&) noexcept=default
	Move constructor.
Public Member Functions inherited from SDL::ResourceBaseT< ProcessRaw >
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBaseT &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::ResourceBaseT< ProcessRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< ProcessRaw >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

An opaque handle representing a system process.

Since

This datatype is available since SDL 3.2.0.

See also

CreateProcess

Category:

Resource

Constructor & Destructor Documentation

Process()

SDL::Process::Process ( ProcessRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw Process.

Parameters

resource

a ProcessRaw to be wrapped.

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

---

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

• SDL3pp/SDL3pp_process.h