Skip to main content

Test to see if a file exists using PowerShell

Normally I would use just the Test-Path cmdlet for this.  The requirement of a project that I’m on needed a “user friendly” output option as well.  Below is an example of that user friendly output.
image
Here is the code:

<#
.SYNOPSIS
Test to see if a file exists.
.DESCRIPTION
Returns TRUE if the file submitted is exists.
Returns FALSE if it does not.
.PARAMETER ExcelFile
The name of the file being tested
.EXAMPLE
get-excelFile Det1.xls -DisplayInfo
File found
True

Verifies that a file names "Det1.xls" exists and also
displays the user friendly information of "File Found"
to the display.  The value of TRUE was returned to the 
pipeline.

.EXAMPLE
get-excelFile "demo.xls"
File not found

Verified that the file named "demo.xls" did not exist
in the location specified.  The value FALSE was
returned to the pipeline.
#>

Function Get-File
{
Param (
[Parameter(Position=0,Mandatory=$True)]$File,
[Switch]$DisplayInfo = $False
)

If (Test-Path $File)
{
# Displays user friendly info on the display.
    If ($DisplayInfo) 
{
Write-Host "File found" -ForegroundColor Green
}
Write-Output $True}
Else {
# Displays user friendly info on the display.
    If ($DisplayInfo) 
{
Write-Host "File not found" -ForegroundColor Red
}
Write-Output $False
}

Comments

Popular posts from this blog

Adding a Comment to a GPO with PowerShell

As I'm writing this article, I'm also writing a customization for a PowerShell course I'm teaching next week in Phoenix.  This customization deals with Group Policy and PowerShell.  For those of you who attend my classes may already know this, but I sit their and try to ask the questions to myself that others may ask as I present the material.  I finished up my customization a few hours ago and then I realized that I did not add in how to put a comment on a GPO.  This is a feature that many Group Policy Administrators may not be aware of. This past summer I attended a presentation at TechEd on Group Policy.  One organization in the crowd had over 5,000 Group Policies.  In an environment like that, the comment section can be priceless.  I always like to write in the comment section why I created the policy so I know its purpose next week after I've completed 50 other tasks and can't remember what I did 5 minutes ago. In the Group Policy module for PowerShell V3, th

Return duplicate values from a collection with PowerShell

If you have a collection of objects and you want to remove any duplicate items, it is fairly simple. # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   # Remove the duplicate values. $Set1 | Select-Object -Unique 1 2 3 4 5 6 7 What if you want only the duplicate values and nothing else? # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   #Create a second collection with duplicate values removed. $Set2 = $Set1 | Select-Object -Unique   # Return only the duplicate values. ( Compare-Object -ReferenceObject $Set2 -DifferenceObject $Set1 ) . InputObject | Select-Object – Unique 1 2 This works with objects as well as numbers.  The first command creates a collection with 2 duplicates of both 1 and 2.   The second command creates another collection with the duplicates filtered out.  The Compare-Object cmdlet will first find items that are diffe

How to list all the AD LDS instances on a server

AD LDS allows you to provide directory services to applications that are free of the confines of Active Directory.  To list all the AD LDS instances on a server, follow this procedure: Log into the server in question Open a command prompt. Type dsdbutil and press Enter Type List Instances and press Enter . You will receive a list of the instance name, both the LDAP and SSL port numbers, the location of the database, and its status.