This namespace contains the classes, enumerations, and interfaces that are used to define a custom host that provides communications between the user and the Windows PowerShell engine. This communications includes dialog-oriented functionality, such as what types of prompts are used, and low-level functionality, such as the foreground and background colors of displayed text.
| Class | Description |
|---|
| ChoiceDescription | Defines a choice that can be presented to the user by the Host interface, such as Yes to &All. |
| FieldDescription | Represents an option that is used in a Windows PowerShell prompt call. |
| HostException | The exception thrown when the host cannot complete an operation, such as when the host is checking whether there is any input available. |
| PromptingException | The exception that is thrown when an error occurs while the host displays a prompt for a command parameter. |
| PSHost | Serves as a base class for creating a custom host. A host provides communications between the Windows PowerShell runtime and the user. |
| PSHostRawUserInterface | Defines the low-level custom host functionality, such as read and write actions, that a host application can implement to support character-mode interaction with the user. |
| PSHostUserInterface | Defines the custom host functionality that is used to perform dialog-oriented and line-oriented interaction, such as writing to, prompting for, and reading from user input. |
| Interface | Description |
|---|
| IHostSupportsInteractiveSession | Provides support for opening and closing, entering and exiting, a PSSession on a computer. This class is introduced in Windows PowerShell 2.0. |
| IHostUISupportsMultipleChoiceSelection | Provides a set of choices that enable the user to choose one or more options. This interface is introduced in Windows PowerShell 2.0. |
| Structure | Description |
|---|
| BufferCell | Represents a buffer cell that has a specific character, foreground color, background color, and cell type. |
| Coordinates | Defines the X (column) and Y (row) coordinates that are used to describe the corners of a Rectangle object. |
| KeyInfo | Represents key information such as the character, virtual key code, the state of any associated control keys, and the state of the key (down). |
| Rectangle | Represents a rectangular region of the screen. |
| Size | Represents a width and height pair. |
| Enumeration | Description |
|---|
| BufferCellType | Defines the type of buffer cells that can be used to display single-cell or double-cell characters. For example, is the cell complete or is a leading or trailing cell for double-cell characters. |
| ControlKeyStates | Defines the states of specific control keys, such as the ALT key, CTRL key, SCROLL key, and CAPSLOCK key. |
| ReadKeyOptions | Defines the options used to control the behavior of the ReadKey method. |