PLCore::Process Class Reference

Class for running and controlling an external process. More...

#include <Process.h>

List of all members.

Public Member Functions
	Process ()
	Constructor.
PLCORE_API	~Process ()
	Destructor.
PLCORE_API void	Execute (const String &sCommand, const String &sArguments)
	Starts a process.
PLCORE_API void	ExecuteRedirectIO (const String &sCommand, const String &sArguments)
	Starts a process with redirected input/output.
PLCORE_API void	ExecuteRedirectIO (const String &sCommand, const String &sArguments, const Pipe &cPipeIn, const Pipe &cPipeOut, const Pipe &cPipeErr)
	Starts a process with redirected input/output.
PLCORE_API void	ExecuteRedirectIO (const String &sCommand, const String &sArguments, handle hPipeIn, handle hPipeOut, handle hPipeErr)
	Starts a process with redirected input/output.
PLCORE_API bool	IsRunning () const
	Returns if the process is running.
PLCORE_API void	Terminate ()
	Terminates the process.
File &	GetInput ()
	Get input stream.
File &	GetOutput ()
	Get output stream.
File &	GetError ()
	Get error stream.
const Pipe &	GetPipeInput () const
	Get input pipe.
const Pipe &	GetPipeOutput () const
	Get output pipe.
const Pipe &	GetPipeError () const
	Get error pipe.

---

Detailed Description

Class for running and controlling an external process.

---

Constructor & Destructor Documentation

PLCore::Process::Process

(

)

[inline]

Constructor.

PLCORE_API PLCore::Process::~Process

(

)

Destructor.

---

Member Function Documentation

PLCORE_API void PLCore::Process::Execute	(	const String &	sCommand,
		const String &	sArguments
	)

Starts a process.

Parameters:

[in]	sCommand	Command to run
[in]	sArguments	Arguments for the command

PLCORE_API void PLCore::Process::ExecuteRedirectIO	(	const String &	sCommand,
		const String &	sArguments
	)

Starts a process with redirected input/output.

Parameters:

[in]	sCommand	Command to run
[in]	sArguments	Arguments for the command

Remarks:

This function creates unnamed pipes to redirect input and output. To access theses pipes, use the appropriate functions like GetInput(), GetOutput() a.s.o. If you want to specify the pipes by yourself, see the other two variations of ExecuteRedirectIO().

PLCORE_API void PLCore::Process::ExecuteRedirectIO	(	const String &	sCommand,
		const String &	sArguments,
		const Pipe &	cPipeIn,
		const Pipe &	cPipeOut,
		const Pipe &	cPipeErr
	)

Starts a process with redirected input/output.

Parameters:

[in]	sCommand	Command to run
[in]	sArguments	Arguments for the command
[in]	cPipeIn	Pipe for input
[in]	cPipeOut	Pipe for output
[in]	cPipeErr	Pipe for error

PLCORE_API void PLCore::Process::ExecuteRedirectIO	(	const String &	sCommand,
		const String &	sArguments,
		handle	hPipeIn,
		handle	hPipeOut,
		handle	hPipeErr
	)

Starts a process with redirected input/output.

Parameters:

[in]	sCommand	Command to run
[in]	sArguments	Arguments for the command
[in]	hPipeIn	System handle for the input pipe
[in]	hPipeOut	System handle for the output pipe
[in]	hPipeErr	System handle for the error pipe

Note:

• On Linux, the handle is a file handle of type int
• On Windows, the handle is a file handle of type HANDLE

PLCORE_API bool PLCore::Process::IsRunning

(

)

const

Returns if the process is running.

Returns:

'true' if running, else 'false'

PLCORE_API void PLCore::Process::Terminate

(

)

Terminates the process.

File & PLCore::Process::GetInput

(

)

[inline]

Get input stream.

Returns:

Input file for the process

File & PLCore::Process::GetOutput

(

)

[inline]

Get output stream.

Returns:

Output file for the process

File & PLCore::Process::GetError

(

)

[inline]

Get error stream.

Returns:

Error file for the process

const Pipe & PLCore::Process::GetPipeInput

(

)

const [inline]

Get input pipe.

Returns:

Input pipe for the process

const Pipe & PLCore::Process::GetPipeOutput

(

)

const [inline]

Get output pipe.

Returns:

Output pipe for the process

const Pipe & PLCore::Process::GetPipeError

(

)

const [inline]

Get error pipe.

Returns:

Error pipe for the process

---

The documentation for this class was generated from the following files:

• Process.h
• Process.inl