FMFlattenFolders

2.0.2

FMFlattenFolders.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>FMFlattenFolders</name>
    </assembly>
    <members>
        <member name="T:FMFlattenFolders.InvokeFlattenFoldersCmdlet">
            <summary>
            <para type="synopsis">Moves files from all sub-directories to the parent directory and optionally delete sub-directories.</para>
            <para type="description">
            Moves files from all sub-directories to the parent directory.If files with duplicate names are found then their file name will have a GUID appended to make them unique.
            </para>
            <para type="description">
            Supports WhatIf. If supplied this will output a formatted table of the from and to file locations that will result from running the cmdlet.
            </para>
            <para type="description">
            Can be run against:
            </para>
            <para type="description">
            > a single directory
            </para>
            <para type="description">
            > a collection of directories piped into the module.
            </para>
            <example>
                <para>All files in all sub-directories in the current location (C:\) will be moved to the current location(C:\):</para>
                <code>PS C:\> Invoke-FlattenFolders</code>
            </example>
            <example>
                <para>Displays an output table to terminal detailing that all files in all sub-directories in C:\Videos\ would be moved to C:\Videos\:</para>
                <code>PS C:\> Invoke-FlattenFolders -Directory "C:\Videos" -WhatIf</code>
            </example>
            <example>
                <para>All files in all sub-directories in C:\Videos\ will be moved to C:\Videos\ and all sub-directories will be deleted once the files have been moved:</para>
                <code>PS C:\> Invoke-FlattenFolders -Directory "C:\Videos" -DeleteSubDirectories</code>
            </example>
            <example>
                <para>All files in all sub-directories in the piped array of directories(C:\Videos\ and C:\Music\) will be moved to their respective parents:</para>
                <code>PS C:\> "C:\Videos\","C:\Music\" | Invoke-FlattenFolders</code>
            </example>
            </summary>
        </member>
        <member name="P:FMFlattenFolders.InvokeFlattenFoldersCmdlet.Directory">
            <summary>
            <para type="description">
            The parent directory where files from all sub-directories will be moved.
            If neither this nor the Directories parameter are set then the current location will be used.
            </para>
            </summary>
        </member>
        <member name="P:FMFlattenFolders.InvokeFlattenFoldersCmdlet.Directories">
            <summary>
            <para type="description">
            A collection of parent directories where files from all sub-directories will be moved.
            If neither this nor the Directory parameter are set then the current location will be used.
            </para>
            </summary>
        </member>
        <member name="P:FMFlattenFolders.InvokeFlattenFoldersCmdlet.WhatIf">
            <summary>
            <para type="description">
            If supplied this will output a formatted table of the from and to file locations that will result from running the cmdlet.
            </para>
            </summary>
        </member>
        <member name="P:FMFlattenFolders.InvokeFlattenFoldersCmdlet.DeleteSubDirectories">
            <summary>
            <para type="description">
            If supplied all subdirectories will be deleted once all files have been moved.
            </para>
            </summary>
        </member>
        <member name="P:FMFlattenFolders.InvokeFlattenFoldersCmdlet.RenameMethod">
            <summary>
            <para type="description">
            The strategy for renaming duplicate files. Valid values are "Guid" or "Index". Defaults to Index.
            </para>
            </summary>
        </member>
        <member name="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.BeginProcessing">
            <summary>
            Implements the <see cref="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.BeginProcessing"/> method for <see cref="T:FMFlattenFolders.InvokeFlattenFoldersCmdlet"/>.
            Initialise temporary containers
            </summary>
        </member>
        <member name="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.ProcessRecord">
            <summary>
            Implements the <see cref="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.ProcessRecord"/> method for <see cref="T:FMFlattenFolders.InvokeFlattenFoldersCmdlet"/>.
            Validates input directory/directories exist and builds a list of directories to process in the EndProcessing method.
            </summary>
        </member>
        <member name="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.EndProcessing">
            <summary>
            Implements the <see cref="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.EndProcessing"/> method for <see cref="T:FMFlattenFolders.InvokeFlattenFoldersCmdlet"/>.
            Perform the folder flattening on the configured directories.
            </summary>
        </member>
        <member name="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.ProcessWhatIf">
            <summary>
            A WhatIf switch parameter was passed so calculate what will happen and output a table to terminal
            </summary>
        </member>
        <member name="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.ValidateMovePermissions">
            <summary>
            Validates whether the user has write permissions to the file sin the supplied directories
            </summary>
            <returns></returns>
        </member>
    </members>
</doc>