Summary
Defines the base class for
ITask classes that invoke Powershell.
- Namespace
- NBuildKit
.MsBuild .Tasks .Core - Base Types
- Derived 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["PowershellCommandLineToolTask"]
class Type type-node
Type-->Derived0["InvokePowershellCommand"]
click Derived0 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Script/InvokePowershellCommand"
Type-->Derived1["InvokePesterOnFile"]
click Derived1 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Testing/InvokePesterOnFile"
Type-->Derived2["InvokePesterOnDirectory"]
click Derived2 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Testing/InvokePesterOnDirectory"
Type-->Derived3["InvokePowershellFile"]
click Derived3 "/nBuildKit.MsBuild/api/NBuildKit.MsBuild.Tasks.Script/InvokePowershellFile"
Syntax
public abstract class PowershellCommandLineToolTask : CommandLineToolTaskConstructors
| Name | Summary |
|---|---|
| Powershell |
Initializes a new instance of the PowershellCommandLineToolTask class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| DefaultDataHandler | Data |
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 | Data |
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.
|
| Log |
bool |
Gets or sets a value indicating whether the environment variables for the process should be logged.
Inherited from CommandLineToolTask
|
| PowershellExePath | ITaskItem |
Gets or sets the full path to the Powershell executable.
|
Methods
| Name | Value | Summary |
|---|---|---|
| ErrorCodeById |
string |
Returns the error code for the given ID.
Inherited from BaseTask
|
| GetAbsolutePath |
string |
Returns the absolute path for the given path item.
Inherited from BaseTask
|
| GetAbsolutePath |
string |
Returns the absolute path for the given path item.
Inherited from BaseTask
|
| GetAbsolutePath |
string |
Returns the absolute path for the given path item.
Inherited from BaseTask
|
| GetFullToolPath |
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 |
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
|
| Invoke |
int |
Invokes the command line tool at the given path with the given arguments.
Inherited from CommandLineToolTask
|
| Invoke |
int |
Invokes the command line tool at the given path with the given arguments.
Inherited from CommandLineToolTask
|
| Invoke |
void |
Executes a powershell script.
|
| InvokePowershellFile |
void |
Executes a powershell script.
|
| Update |
void |
Updates the environment variables for the application prior to execution.
Inherited from CommandLineToolTask
|
| Verbosity |
string |
Gets the verbosity that the current MsBuild instance is running at.
Inherited from BaseTask
static
|