Export (0) Print
Expand All

Out-Host

Updated: May 8, 2014

Applies To: Windows PowerShell 4.0

Out-Host

Sends output to the command line.

Aliases

The following abbreviations are aliases for this cmdlet:

  • oh

Syntax

Parameter Set: Default
Out-Host [-InputObject <PSObject> ] [-Paging] [ <CommonParameters>]




Detailed Description

The Out-Host cmdlet sends output to the Windows PowerShell host for display. The host displays the output at the command line. Because Out-Host is the default, you do not need to specify it unless you want to use its parameters to change the display.

Parameters

-InputObject<PSObject>

Specifies the objects that are written to the console. Enter a variable that contains the objects, or type a command or expression that gets the objects.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Paging

Displays one page of output at a time, and waits for user input before displaying the remaining pages, much like the traditional "more" command. By default, all of the output is displayed on a single page. The page size is determined by the characteristics of the host.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Management.Automation.PSObject

    You can pipe any object to Out-Host.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

    Out-Host does not generate any output. However, the host might display the objects that Out-Host sends to it.


Notes

  • The cmdlets that contain the Out verb (the Out cmdlets) do not format objects; they just render them and send them to the specified display destination. If you send an unformatted object to an Out cmdlet, the cmdlet sends it to a formatting cmdlet before rendering it.

  • The Out cmdlets do not have parameters for names or file paths. To send data to an Out cmdlet, use a pipeline operator (|) to send the output of a Windows PowerShell command to the cmdlet. You can also store data in a variable and use the InputObject parameter to pass the data to the cmdlet. For help, see the examples.

  • Out-Host sends data, but it does not emit any output objects. If you pipe the output of Out-Host to the Get-Member cmdlet, Get-Member reports that no objects have been specified.

Examples

-------------------------- EXAMPLE 1 --------------------------

This command displays the processes on the system one page at a time. It uses the Get-Process cmdlet to get the processes on the system. The pipeline operator (|) sends the results to Out-Host, which displays them at the console. The Paging parameter displays one page of data at a time.

The same command format is used for the Help function that is built into Windows PowerShell. That function gets data from the Get-Help cmdlet and then uses the Paging parameter of Out-Host to display the data one page at a time by using this command format: Get-Help $Args[0] | Out-Host -Paging.


PS C:\> Get-Process | Out-Host -Paging

-------------------------- EXAMPLE 2 --------------------------

These commands display the session history at the command line. The first command uses the Get-History cmdlet to get the session history, and then it stores the history in the $a variable. The second command uses Out-Host to display the content of the $a variable, and it uses the InputObject parameter to specify the variable to Out-Host.


PS C:\> $a = Get-History
PS C:\>Out-Host -InputObject $a

Related topics


Clear-Host

Out-Default

Out-File

Out-Null

Out-Printer

Out-String

Write-Host



Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft