ExecWithArguments Class

Summary

Defines a ITask that invokes a tool with the given argument set.
Namespace
NBuildKit.MsBuild.Tasks.Script
Base Types
graph TD Base0["CommandLineToolTask"]-->Type click Base0 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/CommandLineToolTask" Base1["BaseTask"]-->Base0 click Base1 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/BaseTask" Base2["Task"]-->Base1 Type["ExecWithArguments"] class Type type-node

Syntax

public sealed class ExecWithArguments : CommandLineToolTask

Constructors

Name Summary
ExecWithArguments() Initializes a new instance of the ExecWithArguments class.
ExecWithArguments(IApplicationInvoker) Initializes a new instance of the ExecWithArguments class.

Properties

Name Value Summary
AdditionalEnvironmentPaths ITaskItem[]
Gets or sets the paths that should be added to the PATH environment variable.
ArgumentPrefix string
Gets or sets the prefix that will be pre-pended to the argument. Defaults to an empty string.
Arguments ITaskItem[]
Gets or sets the arguments for the tool invocation. Items are expected to consist of the argument name with a meta data item called 'Value' which provides the value for the argument.
ArgumentSeparator string
Gets or sets the separator character that will be used to separate the argument and its value. Defaults to a space character.
DefaultDataHandler DataReceivedEventHandler
Gets the event handler that processes data from the data stream, or standard output stream, of the command line application.By default logs a message for each output.
Inherited from CommandLineToolTask
DefaultErrorHandler DataReceivedEventHandler
Gets the event handler that processes data from the data stream, or standard output stream, of the command line application.By default logs a message for each output.
Inherited from CommandLineToolTask
ErrorInformation ITaskItem[]
Gets or sets the collection containing the error codes for the task.
Inherited from BaseTask
IgnoreErrors bool
Gets or sets a value indicating whether error should be ignored.
IgnoreExitCode bool
Gets or sets a value indicating whether the exit code should be ignored.
LogEnvironmentVariables bool
Gets or sets a value indicating whether the environment variables for the process should be logged.
Inherited from CommandLineToolTask
ToolPath ITaskItem
Gets or sets the path to the executable.
WorkingDirectory ITaskItem
Gets or sets the full path to the working directory.

Methods

Name Value Summary
ErrorCodeById(string) string
Returns the error code for the given ID.
Inherited from BaseTask
Execute() bool
GetAbsolutePath(ITaskItem) string
Returns the absolute path for the given path item.
Inherited from BaseTask
GetAbsolutePath(ITaskItem, ITaskItem) string
Returns the absolute path for the given path item.
Inherited from BaseTask
GetAbsolutePath(string) string
Returns the absolute path for the given path item.
Inherited from BaseTask
GetFullToolPath(ITaskItem) string
Returns the most complete path for the given executable tool. May return just the name of the tool if the tool path is found via the PATH environment variable.
Inherited from CommandLineToolTask
GetFullToolPath(string) string
Returns the most complete path for the given executable tool. May return just the name of the tool if the tool path is found via the PATH environment variable.
Inherited from CommandLineToolTask
InvokeCommandLineTool(ITaskItem, IEnumerable<string>, ITaskItem, DataReceivedEventHandler, DataReceivedEventHandler) int
Invokes the command line tool at the given path with the given arguments.
Inherited from CommandLineToolTask
InvokeCommandLineTool(string, IEnumerable<string>, string, DataReceivedEventHandler, DataReceivedEventHandler) int
Invokes the command line tool at the given path with the given arguments.
Inherited from CommandLineToolTask
UpdateEnvironmentVariables(StringDictionary) void
Updates the environment variables for the application prior to execution.
VerbosityForCurrentMsBuildInstance() string
Gets the verbosity that the current MsBuild instance is running at.
Inherited from BaseTask
static