The maximum number of lines in my environment is 47.
Can I measure this value programmatically?
To complement Christian.K's helpful answer:
A simpler and slightly more efficient method for obtaining the host object is to use the $Host
automatic variable rather than the Get-Host
cmdlet.
You're only guaranteed to have access to window-size information in the PowerShell console host, i.e., when running in a console (terminal) window
To test whether your code is running in a console (a.k.a terminal) or not, use
$Host.UI.SupportsVirtualTerminal
- $True
indicates that the host is a console.
You can access the console's properties either:
via $Host.UI.RawUI
(as in Christian's answer), which is an object of type [System.Management.Automation.Internal.Host.InternalHostRawUserInterface]
that - in the PowerShell console host only - wraps the .NET [Console]
class (see below).
via the .NET [Console]
class; e.g., to get the window height (count of rows) this way, use:
[Console]::WindowHeight
Sample $Host.UI.RawUI
output:
PS> $Host.UI.RawUI
ForegroundColor : DarkYellow
BackgroundColor : DarkMagenta
CursorPosition : 0,58
WindowPosition : 0,0
CursorSize : 25
BufferSize : 160,9999
WindowSize : 160,75
MaxWindowSize : 160,94
MaxPhysicalWindowSize : 303,94
KeyAvailable : True
WindowTitle : Windows PowerShell
Written as of PowerShell version 5.1
Most of the properties in $Host.UI.RawUI
are not populated and will return their data type's default value:
PS> $Host.UI.RawUI # in the ISE
ForegroundColor : -1
BackgroundColor : -1
CursorPosition : 0,0
WindowPosition :
CursorSize :
BufferSize : 166,0
WindowSize :
MaxWindowSize :
MaxPhysicalWindowSize :
KeyAvailable :
WindowTitle : Windows PowerShell ISE
The only size-related information that is available is the buffer width (166
in the sample output above).
There is no point in trying to use the .NET [Console]
class in the ISE, except to query / set the character encoding used for communication with external programs, [Console]::OutputEncoding
:[1]
Initially in a session, trying to use the window-related members of [Console]
causes exceptions, because the ISE does not allocate a console window on startup:
# In a pristine session.
PS> [Console]::WindowHeight
The handle is invalid. # EXCEPTION
While the ISE allocates a - hidden - console window on demand, namely the first time you run a console application in your session, that hidden console window's properties, as then reported on via [Console]
, do not reflect the properties of the simulated console that the ISE presents to the user.
# chcp is a console application, so when it is run,
# the ISE allocates a (hidden) console window,
# after which the [Console] API becomes technically usable,
# but DOESN'T REPORT MEANINGFUL VALUES.
PS> chcp >$null; [Console]::WindowHeight
72 # No exception, but the value is meaningless.
[1] Note that the ISE defaults to the system's legacy ANSI code page, whereas regular console windows default to the OEM code page. Thus, these two environments decode output from external programs differently by default.