Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ForEachObject Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Activity to invoke the Microsoft.PowerShell.Core\ForEach-Object command in a workflow. Introduced in Windows PowerShell 3.0.

Namespace:   Microsoft.PowerShell.Core.Activities
Assembly:  Microsoft.PowerShell.Core.Activities (in Microsoft.PowerShell.Core.Activities.dll)

System.Object
  System.Activities.Activity
    System.Activities.NativeActivity
      Microsoft.PowerShell.Activities.PipelineEnabledActivity
        Microsoft.PowerShell.Activities.PSActivity
          Microsoft.PowerShell.Core.Activities.ForEachObject

public sealed class ForEachObject : PSActivity

NameDescription
System_CAPS_pubmethodForEachObject()

Gets the display name of the command invoked by this activity. Introduced in Windows PowerShell 3.0.

NameDescription
System_CAPS_pubpropertyAppendOutput

Determines whether to append output to the stream specified by the Result property. Introduced in Windows PowerShell 3.0.(Inherited from PipelineEnabledActivity.)

System_CAPS_pubpropertyArgumentList

Provides access to the ArgumentList parameter. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyBegin

Provides access to the Begin parameter. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertyCacheId

(Inherited from Activity.)

System_CAPS_pubpropertyDebug

Gets or sets a value that indicates whether to emit the debug output of the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyDisplayName

(Inherited from Activity.)

System_CAPS_pubpropertyEnd

Provides access to the End parameter. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyErrorAction

Gets or sets how errors are handled by the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyId

(Inherited from Activity.)

System_CAPS_protpropertyImplementationVersion

(Inherited from NativeActivity.)

System_CAPS_pubpropertyInformationAction

Determines how information records should be handled by the activity. (Inherited from PSActivity.)

System_CAPS_pubpropertyInput

The input stream for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PipelineEnabledActivity.)

System_CAPS_pubpropertyInputObject

Provides access to the InputObject parameter. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyMemberName

Provides access to the MemberName parameter. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyMergeErrorToOutput

Gets or sets a value that indicates whether to merge error data to the output stream. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyProcess

Provides access to the Process parameter. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSActionRetryCount

Gets or sets the number of times the activity retries execution of an action after encountering an execution error. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSActionRetryIntervalSec

Gets or sets the number of seconds to wait before retrying the action. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSActionRunningTimeoutSec

Gets or sets the number of seconds to wait before the action times out. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSCommandName

Gets the fully qualified name of the command invoked by this activity. Introduced in Windows PowerShell 3.0.(Overrides PSActivity.PSCommandName.)

System_CAPS_pubpropertyPSDebug

Gets or sets the debug stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSDisableSerialization

Gets or sets a value that indicates whether to disable serialization for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSError

Gets or sets the error stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSInformation

The Information stream / collection for the activity. (Inherited from PSActivity.)

System_CAPS_pubpropertyPSPersist

Gets or sets a value that indicates whether to force the activity to persist the workflow state onto the disk. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSProgress

Gets or sets the progress stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSProgressMessage

Gets or sets the message in the progress stream. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSRequiredModules

Gets or sets the list of module names or paths that are required to run this activity successfully. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSVerbose

Gets or sets the verbose stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyPSWarning

Gets or sets the warning stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyRemainingScripts

Provides access to the RemainingScripts parameter. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyResult

The output stream from the activity. Introduced in Windows PowerShell 3.0.(Inherited from PipelineEnabledActivity.)

System_CAPS_pubpropertyUseDefaultInput

Specifies whether to connect the input stream for this activity. Introduced in Windows PowerShell 3.0.(Inherited from PipelineEnabledActivity.)

System_CAPS_pubpropertyVerbose

Gets or sets a value that indicates whether to emit verbose output of the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

System_CAPS_pubpropertyWarningAction

Gets or sets how warnings are handled by the activity. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Activity.)

System_CAPS_protmethodUpdateImplementationContextForLocalExecution(ActivityImplementationContext, ActivityContext)

Updates the ActivityImplementationContext returned from the GetPowerShell method to support local execution against the host's runspace pool. Introduced in Windows PowerShell 3.0.(Inherited from PSActivity.)

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Community Additions

Show: