Cpl::System::Shell Class Reference

This class defines methods for interfacing with the Platform native OS to execute a native OS system/shell command. More...

Detailed Description

This class defines methods for interfacing with the Platform native OS to execute a native OS system/shell command.

Support for this interface is target/platform specific, i.e. support for this interface is OPTIONAL. If the target does not support this interface, then the 'execute' method does NOTHING (and returns -1); and the method isAvailable() return false.

#include <Shell.h>

Static Public Member Functions
static int	execute (const char *cmdstring, bool noEchoStdOut=true, bool noEchoStdErr=true)
	Executes the System Shell command as specified by 'cmdstring'.
static bool	isAvailable ()
	Returns true if the system command shell is available.

Member Function Documentation

execute()

static int Cpl::System::Shell::execute ( const char *  cmdstring, bool  noEchoStdOut = true, bool  noEchoStdErr = true  )

static

Executes the System Shell command as specified by 'cmdstring'.

If noEchoStdOut is set to true then the standard output of the shell command is set to the system's NUL device. If noEchoStdErr is set to true then the standard error output of the shell command is set to the system's NUL device. The method returns -1 if unable to execute the command, else returns the result code of the command executed.

isAvailable()

static bool Cpl::System::Shell::isAvailable ( )

static

Returns true if the system command shell is available.

---

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

• Cpl/System/Shell.h