PowerShell/Docs/list-files.md
2023-05-26 12:20:18 +02:00

66 lines
1.5 KiB
Markdown

## The *list-files.ps1* Script
This PowerShell script lists all files within the given directory tree.
## Parameters
```powershell
/home/mf/Repos/PowerShell/Scripts/list-files.ps1 [[-DirTree] <String>] [<CommonParameters>]
-DirTree <String>
Specifies the path to the directory tree
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./list-files C:\
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Source Code
```powershell
<#
.SYNOPSIS
Lists all files in a directory tree
.DESCRIPTION
This PowerShell script lists all files within the given directory tree.
.PARAMETER DirTree
Specifies the path to the directory tree
.EXAMPLE
PS> ./list-files C:\
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$DirTree = "")
try {
if ($DirTree -eq "" ) { $DirTree = read-host "Enter path to directory tree" }
Get-ChildItem -path $DirTree -recurse | select FullName
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*Generated by convert-ps2md.ps1 using the comment-based help of list-files.ps1*