Sunday, August 06, 2006
$Host is an implementation of System. Management. Automation. Host. PSHost abstract class. PSHost defined some important properties and methods which will be used for all cmdlet. For more detailed information about PSHost, you can consult Monad SDK online.
Let's see what we can do with $host
1. Some read-only properties provide information about current host.
These could be useful when you have to distinguish among multiple hosts (For example, my PowerShell Remoting has a remote host. Remote host have different Name, InstanceId, Version, etc).
2. Two methods to support legacy application (like ping.exe).
Usually you do not need to call them directly. Monad engine will call them automatically if you invoke legacy application.
3. Two methods about nested prompt.
I already discussed how to use those methods previously.
4. One method to force PowerShell exit.
This could be useful if some sever error occurs and you want to quit PowerShell.exe from your script. You can also pass error code to environment. For example:
This is an implementation of PSHostUserInterface object which expose some import user interface API.
5.1 public override Dictionary<string, PSObject> Prompt(string caption, string message, Collection<FieldDescription> descriptions)
This API is called when cmdlet required field(s) is null or empty. It is capable of get user input ([string]) and cnvert them to almost any .Net type in current appdomain. But the task of constructing Collection<FieldDescription> from script can be daunting.
5.2 public override int PromptForChoice(string caption, string message, Collection<ChoiceDescription> choices, int defaultChoice)
This is standard PowerShell text-base menu system. Don't re-invent wheels! If you want to provide a menu for user input, look nowhere and this method got you all covered. Mow has a nice example of how to use this methods.
5.3 Some more input API to get user input
- ReadLine: Read a line from standard input, similar to read-host cmdlet
- PromptForCredential: Get PSCredential object from User input, similar to get-credential cmdlet.
- ReadLineAsSecureString: read from standard input and convert to SecureString, similar to Read-host -AsSecureString
5.4 Some output API to direct output to different channel and with color support.
- Write: Write to standard output without /n/r
- WriteLine: Write a line to standard output
- WriteProgress: Wrtie to Progress panel, similar to Write-progress cmdlet
- WriteDebugLine: Write to Debug channel, similar to Write-debug cmdlet
- WriteErrorLine: Write to Standard Error, similar to Write-error cmdlet
- WriteVerboseLine: Write to Verbose channel, similar to Write-verbose cmdlet
- WriteWarningLine: Wrtie to Warning channel, similar to Write-warning cmdlet
This is an implementation of PSHostRawUserInterface abstract class. This is a new concept in PowerShell. In the prompt post, we use this object to do a lot of tricks.
5.5.1 Some properties to control Console window size, window title, cursor, buffer size, background/foreground color
5.5.2 Some console buffer API. Lee has a great burn-console script to demonstrate these methods.
5.5.3 public override KeyInfo ReadKey(ReadKeyOptions options)
It is a powerful API to read keyboard input. Check out the retuned KeyInfo object, with this method, one can theoretically write a script act like a simple screen editor.
Here is the ReadKeyOption enum:
public enum ReadKeyOptions
AllowCtrlC = 1,
IncludeKeyDown = 4,
IncludeKeyUp = 8,
NoEcho = 2
VirtualKeyCode Character ControlKeyState KeyDown
-------------- --------- --------------- -------
65 a 262176 True
Just to remind you, my PowerShell Remoting remote host implemented all Host, UI and RawUI. So feel free to explore those interesting API on you remote host.
I kind of wished that you could direct users to check out "about_automatic_variables" and look for "$host".
But there is a typo on the documenation. Instead of "$host", there is an entry for "$PsHost",
Contains information about the current host
but it seems to mean "$host" since there is no entry for "$host" and the description on "about_*" doc fits the description of $host according to your blog entry.
Thank you for the great reference again.
By the way, I have just posted about this doc bug on Microsoft Connect site
FeedBack ID: 177597
Oes Tsetnoc | Semangat Mengembalikan Jati Diri Bangsa
Links to this post: