WriteError Class

Definition

Namespace:

Microsoft.PowerShell.Utility.Activities

Assembly:

Microsoft.PowerShell.Utility.Activities.dll

Package:

Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Activity to invoke the Microsoft.PowerShell.Utility\Write-Error command in a Workflow.

public ref class WriteError sealed : Microsoft::PowerShell::Activities::PSActivity

public sealed class WriteError : Microsoft.PowerShell.Activities.PSActivity

type WriteError = class
    inherit PSActivity

Public NotInheritable Class WriteError
Inherits PSActivity

Inheritance

NativeActivity

PipelineEnabledActivity

PSActivity

WriteError

Constructors

WriteError()

Gets the display name of the command invoked by this activity.

Properties

AppendOutput	Determines whether to append output to Result. (Inherited from PipelineEnabledActivity)
CanInduceIdle	In order for an activity to go idle, 'CanInduceIdle' should be true. (Inherited from PSActivity)
Category	Provides access to the Category parameter.
CategoryActivity	Provides access to the CategoryActivity parameter.
CategoryReason	Provides access to the CategoryReason parameter.
CategoryTargetName	Provides access to the CategoryTargetName parameter.
CategoryTargetType	Provides access to the CategoryTargetType parameter.
Debug	Determines whether to emit debug output of the activity. (Inherited from PSActivity)
DefiningModule	If an activity needs to load a module before it can execute, override this member to return the name of that module. (Inherited from PSActivity)
ErrorAction	Determines how errors should be handled by the activity. (Inherited from PSActivity)
ErrorId	Provides access to the ErrorId parameter.
ErrorRecord	Provides access to the ErrorRecord parameter.
Exception	Provides access to the Exception parameter.
InformationAction	Determines how information records should be handled by the activity. (Inherited from PSActivity)
Input	The Input stream for the activity. (Inherited from PipelineEnabledActivity)
MergeErrorToOutput	Determines whether to merge error data to the output stream (Inherited from PSActivity)
Message	Provides access to the Message parameter.
ParameterDefaults	Provides access to the parameter defaults dictionary (Inherited from PSActivity)
PSActionRetryCount	Defines the number of retries that the activity will make when it encounters an error during execution of its action. The default is to not retry. (Inherited from PSActivity)
PSActionRetryIntervalSec	Defines the delay, in seconds, between action retry attempts. The default is one second. (Inherited from PSActivity)
PSActionRunningTimeoutSec	Defines the maximum amount of time, in seconds, that this activity may run. The default is unlimited. (Inherited from PSActivity)
PSCommandName	Gets the fully qualified name of the command invoked by this activity.
PSDebug	The Debug stream / collection for the activity. (Inherited from PSActivity)
PSDefiningModule	Returns the module defining the command called by this activity. It may be null. (Inherited from PSActivity)
PSDisableSerialization	Forces the activity to return non-serialized objects. Resulting objects have functional methods and properties (as opposed to serialized versions of them), but will not survive persistence when the Workflow crashes or is persisted. (Inherited from PSActivity)
PSError	The Error stream / collection for the activity. (Inherited from PSActivity)
PSInformation	The Information stream / collection for the activity. (Inherited from PSActivity)
PSPersist	Forces the activity to not call the persist functionality, which will be responsible for persisting the workflow state onto the disk. (Inherited from PSActivity)
PSProgress	The Progress stream / collection for the activity. (Inherited from PSActivity)
PSProgressMessage	In addition to the display name PSProgress Message will provide the way to append the additional information into the activity progress message like branch name or iteration number in case of parallel foreach. (Inherited from PSActivity)
PSRequiredModules	This the list of module names (or paths) that are required to run this Activity successfully. The default is null. (Inherited from PSActivity)
PSVerbose	The Verbose stream / collection for the activity. (Inherited from PSActivity)
PSWarning	The Warning stream / collection for the activity. (Inherited from PSActivity)
RecommendedAction	Provides access to the RecommendedAction parameter.
Result	The output stream from the activity (Inherited from PipelineEnabledActivity)
TargetObject	Provides access to the TargetObject parameter.
Tracer	Tracer initialization. (Inherited from PSActivity)
UpdatePreferenceVariable	Indicates if preference variables need to be updated (Inherited from PSActivity)
UseDefaultInput	Determines whether to connect the input stream for this activity. (Inherited from PipelineEnabledActivity)
Verbose	Determines whether to emit verbose output of the activity. (Inherited from PSActivity)
WarningAction	Determines how warnings should be handled by the activity. (Inherited from PSActivity)

Methods

ActivityEndPersistence(NativeActivityContext)	The method is override-able by the drived classes in case they would like to implement different logic at the end of persistence. The default behavior would be to schedule the 'Persist' activity if the PSPersist flag is true or Host is asking for it. (Inherited from PSActivity)
CacheMetadata(NativeActivityMetadata)	Retrieves the stream and ubiquitous parameter information from the hosting application. These must be passed in as "Streams" and "UbiquitousParameters", respectively. (Inherited from PSActivity)
Cancel(NativeActivityContext)	Cancel the running activity (Inherited from PSActivity)
Execute(NativeActivityContext)	Begins the execution of the activity. (Inherited from PSActivity)
GetActivityArguments()	Retrievs all of the default arguments from the type and its parents. (Inherited from PSActivity)
GetImplementation(NativeActivityContext)	Overload this method to implement any command-type specific preparations. If this command needs any workflow-specific information during its PrepareSession call, it should be stored in ActivityImplementationContext.WorkflowContext. (Inherited from PSActivity)
GetPowerShell(NativeActivityContext)	The method for derived activities to return a configured instance of System.Management.Automation.PowerShell. The implementor should have added all of the commands and parameters required to launch their command through the standard AddCommand() and AddParameter() methods. Derived activites should not manage the Runspace property directly, as the PSActivity class configures the runspace afterward to enable remote connections. (Inherited from PSActivity)
GetRunInProc(ActivityContext)	Determine if this activity should be run in or out of process when run locally/ (Inherited from PSActivity)
PrepareSession(ActivityImplementationContext)	The method for derived activities to customize the runspace of a System.Management.Automation.PowerShell instance that the runtime has prepared for them. If the command needs any workflow-specific information during this PrepareSession call, it should be stored in ActivityImplementationContext.WorkflowContext during the GetCommand preparation phase. (Inherited from PSActivity)
UpdateImplementationContextForLocalExecution(ActivityImplementationContext, ActivityContext)	Updates the ImplementationContext returned from GetPowerShell() to support local execution against the host's runspace pool. (Inherited from PSActivity)
WriteProgressRecord(NativeActivityContext, PSDataCollection<ProgressRecord>, String, ProgressRecordType)	Write a progress record fo the current activity (Inherited from PSActivity)