FMFlattenFolders.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>FMFlattenFolders</name> </assembly> <members> <member name="T:FMFlattenFolders.InvokeFlattenFoldersCmdlet"> <summary> <para type="synopsis"> Moves all containing files including those within all sub-directories of a supplied directory to the root directory and optionally deletes empty sub-directories after the operation. </para> <para type="description"> Moves all containing files including those within all sub-directories of a supplied directory to the root directory and optionally deletes empty sub-directories after the operation. Supports renaming duplicate files with a unique GUID, or a numerical index. The index can be zero-padded to a custom length. Supports multiple directories with the -Directories parameter. Also supports pipeline input: Multiple directories can be piped into the command. </para> <example> <para>All files in all sub-directories of "C:\Icons\SVG Sets" will be moved to "C:\Icons\SVG Sets". Duplicate files will be renamed with an appended index. All remaining empty subdirectories will be deleted once the files have been moved.:</para> <code>PS C:\> Invoke-FlattenFolders -Directory "C:\Icons\SVG Sets" -RenameMethod Index -DeleteSubdirectories</code> </example> <example> <para>Displays an output table to the console detailing the flattening operation without actually modifying any files on disk.:</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 files in all sub-directories of "C:\Music" will be moved to "C:\Music". Duplicate files will be renamed with an appended GUID. All remaining empty subdirectories will be deleted once the files have been moved.:</para> <code>PS C:\> Invoke-FlattenFolders -Directories "C:\Videos", "C:\Music" -RenameMethod GUID -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 parent folders. All remaining empty subdirectories will be deleted once the files have been moved.:</para> <code>PS C:\> "C:\Videos\","C:\Music\" | Invoke-FlattenFolders -DeleteSubdirectories</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.RenameMethod"> <summary> <para type="description"> The rename strategy to use for duplicate files. Valid values are GUID or Index. GUID will append a GUID to duplicate files. Index will append a numeric index to duplicate files. </para> </summary> </member> <member name="P:FMFlattenFolders.InvokeFlattenFoldersCmdlet.IndexZeroPadding"> <summary> <para type="description"> The amount of zero padding to apply to indexes when the RenameMethod is set to 'Index' </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.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="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.BeginProcessing"> <summary> Implements the <see cref="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.BeginProcessing"/> method for <see cref="T:FMFlattenFolders.InvokeFlattenFoldersCmdlet"/>. Initializes temporary containers at the beginning of processing. </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 directories exist and prepares them for processing. 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"/>. Performs the folder flattening operation on validated directories. </summary> </member> <member name="M:FMFlattenFolders.InvokeFlattenFoldersCmdlet.ProcessWhatIf"> <summary> Simulates the operation and outputs expected results when 'WhatIf' is used. </summary> </member> </members> </doc> |