PForEach.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>PForEach</name>
    </assembly>
    <members>
        <member name="T:PForEach.InvokeForEachParallel">
            <summary>
            <para type="synopsis">ForEach-Object parallel version. This is one more attempt to make parallel script execution easier.</para>
            <para type="description">This cmdlet runs script block of Process param in parallel using multiple runspaces</para>
            </summary>
            <example>
            <para>Very simple example</para>
            <para>1..5|%%{$_}</para>
            <para>Number from 1-5 will be displayed in rundom sequence. %% is alias of this cmdlet</para>
            </example>
            <example>
            <para>Generate hash of files in c:\temp</para>
            <para>ls -Recurse C:\Temp\|%% {Get-FileHash -Path $_.FullName}</para>
            <para>Generate files' hash in parallel. Depending on files' number and size, execution time can be bigger or less than traditional ForEach-Object</para>
            </example>
        </member>
        <member name="P:PForEach.InvokeForEachParallel.InputObject">
            <summary>
            <para type="description">Specifies the input objects. The script block will be executed on each object in parallel</para>
            </summary>
        </member>
        <member name="P:PForEach.InvokeForEachParallel.Process">
            <summary>
            <para type="description">Specifies the operation that is performed on each input object</para>
            </summary>
        </member>
        <member name="P:PForEach.InvokeForEachParallel.Begin">
            <summary>
            <para type="description">Specifies a script block that runs before this cmdlet processes any input objects.</para>
            </summary>
        </member>
        <member name="P:PForEach.InvokeForEachParallel.End">
            <summary>
            <para type="description">Specifies a script block that runs after this cmdlet processes all input objects.</para>
            </summary>
        </member>
        <member name="P:PForEach.InvokeForEachParallel.ThrottleLimit">
            <summary>
            <para type="description">Sets maximum number of runspaces being created.</para>
            </summary>
        </member>
    </members>
</doc>