System.Management.Automation.Host Namespace

The System.Management.Automation.Host 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.
ClassDescription
ChoiceDescriptionDefines a choice that can be presented to the user by the host interface, such as Yes to &All.
FieldDescriptionRepresents an option that is used in a Windows PowerShell prompt call.
HostExceptionThe exception thrown when the host cannot complete an operation, such as when the host is checking whether there is any input available.
PromptingExceptionThe exception that is thrown when an error occurs while the host displays a prompt for a command parameter.
PSHostContains the base functionality for creating a custom host. A host provides communications between the Windows PowerShell engine and the user.
PSHostRawUserInterfaceDefines the low-level host functionality, such as read and write actions, that a host application can implement to support cmdlets that perform character-mode interaction with the user.
PSHostUserInterfaceDefines 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.
InterfaceDescription
IHostSupportsInteractiveSessionUse this interface to enable cmdlets such as Enter-PsSession and Exit-PsSession. This class is introduced in Windows PowerShell 2.0.
IHostUISupportsMultipleChoiceSelectionProvides a set of choices that enable the user to choose one or more options. This interface is introduced in Windows PowerShell 2.0.
StructureDescription
BufferCellRepresents a buffer cell that has a specific character, foreground color, background color, and cell type.
CoordinatesDefines the X (column) and Y (row) coordinates that are used to describe the corners of a Rectangle object.
KeyInfoRepresents key information such as the character, virtual key code, the state of any associated control keys, and the state of the key (down).
RectangleRepresents a rectangular region of the screen.
SizeRepresents a width and height pair.
EnumerationDescription
BufferCellTypeDefines 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.
ControlKeyStatesDefines the states of specific control keys, such as the ALT key, CTRL key, SCROLL key, and CAPSLOCK key.
ReadKeyOptionsDefines the options used to control the behavior of the ReadKey method.

Send comments about this topic to Microsoft.
Show:
© 2014 Microsoft. All rights reserved.