PoshCode Archive  Artifact Content

Artifact 07acdcb76b31ad7be573891d067d1ee3274ebc88a8f9bbbe15b246c9b4f5634c:

  • File Test-EmptyFolder.ps1 — part of check-in [356a639142] at 2018-06-10 13:18:10 on branch trunk — The Test-EmptyFolder function tests if a specified folder is empty by checking if it (user: Rich Kusak size: 2452)

# encoding: ascii
# api: powershell
# title: Test-EmptyFolder
# description: The Test-EmptyFolder function tests if a specified folder is empty by checking if it
# version: 1.0.0.0
# type: function
# author: Rich Kusak
# license: CC0
# function: Test-EmptyFolder
# x-poshcode-id: 2983
# x-archived: 2011-10-11T07:36:58
# x-published: 2011-10-03T08:48:00
#
# contains files or folders. The function returns the folder path and a boolean value for empty.
#
function Test-EmptyFolder {
<#
	.SYNOPSIS
		Tests for empty folders.

	.DESCRIPTION
		The Test-EmptyFolder function tests if a specified folder is empty by checking if it
		contains files or folders. The function returns the folder path and a boolean value for empty.

	.PARAMETER Path
		Specifies the path of the folder to test.

	.EXAMPLE
		Test-EmptyFolder
		Returns if the current path is an empty folder.

	.EXAMPLE
		Test-EmptyFolder C:\temp
		Returns if the path C:\temp is an empty folder.

	.EXAMPLE
		dir $env:TEMP -Recurse | Test-EmptyFolder
		Gets a directory listing of the TEMP folder including recursive items and
		passes each object into the pipeline testing for empty folders.

	.INPUTS
		System.String

	.OUTPUTS
		PSObject

	.NOTES
		Name: Test-EmptyFolder
		Author: Rich Kusak
		Created: 2011-09-25
		LastEdit: 2011-10-03 10:44
		Version: 1.0.0.0

	.LINK
		http://msdn.microsoft.com/en-us/library/kx74h1k4.aspx

#>

	[CmdletBinding()]
	param (
		[Parameter(Position=0, ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)]
		[ValidateScript({
			if (Test-Path -LiteralPath $_) {$true} else {
				throw "The argument '$_' does not specify an existing path."
			}
		})]
		[Alias('FullName')]
		[string]$Path = '.'
	)
	
	begin {
	
		$properties = 'Path','IsEmpty'

	} # begin
	
	process {
	
		if (Test-Path -LiteralPath $Path -PathType Leaf) {
			return Write-Verbose "The path '$Path' is a file. Only folders are tested."
		}
		
		try {
			$folder = Get-Item $Path -Force -ErrorAction Stop
		} catch {
			return Write-Error $_
		}

		try {
			$isEmpty = ($folder.GetFiles().Count -eq 0) -and ($folder.GetDirectories().Count -eq 0)
		} catch {
			return Write-Error $_.Exception.InnerException.Message
		}
			
		New-Object PSObject -Property @{
			'Path' = $folder.FullName
			'IsEmpty' = $isEmpty
		} | Select $properties

	} # process
} # function Test-EmptyFolder