AzFramework::ProcessLauncher::ProcessLaunchInfo Struct Reference

Public Member Functions
AZStd::string	GetCommandLineParametersAsString () const

Public Attributes
AZStd::string	m_processExecutableString
	This is the process to execute. Do not escape spaces here.
AZStd::variant< AZStd::string, AZStd::vector< AZStd::string > >	m_commandlineParameters
AZStd::string	m_workingDirectory
ProcessPriority	m_processPriority = PROCESSPRIORITY_NORMAL
AZStd::vector< AZStd::string > *	m_environmentVariables = nullptr
ProcessLaunchResult	m_launchResult = PLR_Success
bool	m_showWindow = true
bool	m_tetherLifetime = false
	Tether the lifetime of this process to the parent; causes the new process to terminate whenever this process ends.

Member Data Documentation

m_commandlineParameters

AZStd::variant<AZStd::string, AZStd::vector<AZStd::string> > AzFramework::ProcessLauncher::ProcessLaunchInfo::m_commandlineParameters

Command line parameters, concatenated. In order to prevent a proliferation of ifdefs all over client code to convert into various standards, instead we assume windows style use of "double quotes" to escape spaces for example: params="hello world" "/Users/JOE SMITH/Desktop" On windows, the command line will be passed as-is to the shell (with quotes) on UNIX/OSX, the command line will be converted as appropriate (quotes removed, but used to chop up parameters)

m_workingDirectory

AZStd::string AzFramework::ProcessLauncher::ProcessLaunchInfo::m_workingDirectory

(optional) If you specify a working directory, the command will be executed with that directory as the current directory. Do not use quotes around the working directory string.

---

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

• Code/Framework/AzFramework/AzFramework/Process/ProcessWatcher.h