A utility class that wraps process launching and provides better tracking and logging.

Namespace

Interfaces

Base Types

graph BT Type-->Base0["object"] Type-.->Interface0["IDisposable"] Type["ProcessLauncher"] class Type type-node

Syntax

public class ProcessLauncher : IDisposable

Constructors

Name	Summary
ProcessLauncher()	Creates a new process launcher without a defined file name or arguments.
ProcessLauncher(string, string[])	Creates a new process launcher with the specified file name and arguments.

Name	Field Type	Constant Value	Summary
PathEnvironmentVariable	string	PATH	static
PathExtEnvironmentVariable	string	PATHEXT	static

Name	Property Type	Summary
AreAnyRunning	bool	Returns `true` if any processes launched by this launcher are currently running.
Arguments	string	The arguments to pass to the process.
ContinueOnError	bool	Toggles throwing an exception if the process exits with a non-zero exit code.
EnvironmentVariables	Dictionary<string, string>	Environment variables to set for the process.
FileName	string	The file name of the process to start.
HideArguments	bool	Toggles whether to hide the arguments list when logging the process command.
IsBackground	bool	Starts the process and leaves it running in the background.
IsErrorExitCode	Func<int, bool>	A function that determines if the exit code from the process was an error.
LogErrors	bool	Toggles whether to log error process output as error messages. If `false`, errors are logged as either informational or debug messages depending on `LogOutput`.
LogOutput	bool	Toggles whether to log standard process output as information messages. If `false`, output is logged as debug messages.
RunningProcesses	IEnumerable<Process>
Timeout	int	Sets a timeout in milliseconds before the process will be terminated.
WorkingDirectory	string	The working directory to use for the process.

Name	Return Value	Summary
Dispose()	void
StartNew(CancellationToken)	int
StartNew(ILoggerFactory, CancellationToken)	int
StartNew(IServiceProvider, CancellationToken)	int
StartNew(TextWriter, TextWriter, CancellationToken)	int
StartNew(TextWriter, TextWriter, ILogger, CancellationToken)	int
StartNew(TextWriter, TextWriter, ILogger, IServiceProvider, CancellationToken)	int
StartNew(TextWriter, TextWriter, ILoggerFactory, CancellationToken)	int
StartNew(TextWriter, TextWriter, IServiceProvider, CancellationToken)	int
WaitForRunningProcesses()	void	Waits for all launched processes to exit (useful for background processes). If any processes are launched while waiting, those will also be waited on.
WithArgument(string, bool)	ProcessLauncher	Adds an argument to the process comment.
WithEnvironmentVariable(string, string)	ProcessLauncher	Sets the specified environment variable for this process.
WithEnvironmentVariables(IEnumerable<KeyValuePair<string, string>>)	ProcessLauncher	Sets the specified environment variables for this process.

Name	Value	Summary
ThrowIfNull<ProcessLauncher>(string)	T	From GuardExtensions
ToDocument<ProcessLauncher>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessLauncher>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessLauncher>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessLauncher>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessLauncher>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ProcessLauncher>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions