InvokePowershellCommand Class

Summary

Defines a ITask that invokes the executes a Powershell command.
Namespace
NBuildKit.MsBuild.Tasks.Script
Base Types
graph TD Base0["PowershellCommandLineToolTask"]-->Type click Base0 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/PowershellCommandLineToolTask" Base1["CommandLineToolTask"]-->Base0 click Base1 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/CommandLineToolTask" Base2["BaseTask"]-->Base1 click Base2 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Core/BaseTask" Base3["Task"]-->Base2 Type["InvokePowershellCommand"] class Type type-node

Syntax

public sealed class InvokePowershellCommand : PowershellCommandLineToolTask

Constructors

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

Properties

Name Value Summary
Command string
Gets or sets the command that should be executed.
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.
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.
LogEnvironmentVariables bool
Gets or sets a value indicating whether the environment variables for the process should be logged.
Inherited from CommandLineToolTask
Output string
Gets or sets the output text from the powershell execution.
PowershellExePath ITaskItem
Gets or sets the full path to the Powershell executable.

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
InvokePowershellCommand(string, ITaskItem, DataReceivedEventHandler, DataReceivedEventHandler) void
Executes a powershell script.
InvokePowershellFile(string, ITaskItem, DataReceivedEventHandler, DataReceivedEventHandler) void
Executes a powershell script.
UpdateEnvironmentVariables(StringDictionary) void
Updates the environment variables for the application prior to execution.
Inherited from CommandLineToolTask
VerbosityForCurrentMsBuildInstance() string
Gets the verbosity that the current MsBuild instance is running at.
Inherited from BaseTask
static