Skip to main content

How to Tell a Script if it is Running in the Shell or ISE?

Sometimes some code just does not work the same in the console as it does in the ISE.  Here is an example.

ISE

PS C:\> [CHAR]50000

Shell

image

All that we did was asked to display the character associated with the ASCII code 50000.  As you can see, the ISE can display it, but the Shell cannot.  So what if you need to alter the behavior of your code or just out right exit your code based on if your code is running in the Shell or ISE.  Well, here is a little function that you can add to your code.

1

2

3

4

5

Function Test-ISEHost

{

    If((Get-host).Name -like "*ISE*") {Write-Output $True}

    Else {Write-Output $False}

}

 

 

Since I run a lot of my code from the ISE, I am testing to see my code is using the ISE or not.  This code will return TRUE if running in the ISE and False otherwise.  With this Boolean value, you can make decisions.

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

Function Do-Something

{

    Function Test-ISEHost

    {

        If((Get-host).Name -like "*ISE*") {Write-Output $True}

        Else {Write-Output $False}

    }

 

    # Use the Test-ISEHost function to determine if

    # execution should continue.

    If (Test-ISEHost)

    {

        # Continue with execution

    }

    Else

    {

       # Exit the code

       Write-Host "This code can only run in the ISE" -ForegroundColor Yellow -BackgroundColor DarkRed

       Break

    }

 

    Write-Host "All Done"

}

This is just an example of making a decision with this code.  Our Test-ISEHost function is now a child function of some other function that we will call Do-Something.  When it is executed in the ISE, it runs to completion.  The message All Done is display.  Copy and paste this into the ConsoleHost and execute it, you will receive the error message on line 18.  Also, the Break statement exits the function and the All Done message is not display because the code stopped executing.

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.