2.2.3.14 HostInfo
This data type represents host information.
This data type is a Complex Object (see section 2.2.5.2 and 2.2.5.2.8) with the following extended properties (see section 2.2.5.3.4.2):
A dictionary of elements with host-related information. See the following table for information about required keys.
Property name: hostDefaultData
Property type: Dictionary (see section 2.2.6.1.6) with Keys that are Signed Ints (see section 2.2.5.1.11) and Values are of the type described in the following table.
Flag specifying if the host object associated with the runspace/RunspacePool is NULL.
Property name: isHostNull.
Property type: Boolean (see section 2.2.5.1.3).
Flag specifying if the UI implementation of the host interface is NULL.
Property name: isHostUINull.
Property type: Boolean (see section 2.2.5.1.3).
Flag specifying if the RawUI implementation of the host interface is NULL.
Property name: isHostRawUINull.
Property type: Boolean (see section 2.2.5.1.3).
Flag specifying whether a command invocation MUST use the host associated with its associated RunspacePool.
Property name: useRunspaceHost.
Property type: Boolean (see section 2.2.5.1.3).
The following are the elements which MUST be included in the _hostDefaultData dictionary.
|
Data |
Type of dictionary value |
Key (for dictionary) |
|---|---|---|
|
ForegroundColor |
Color - see section 2.2.3.3 |
0 |
|
BackgroundColor |
Color - see section 2.2.3.3 |
1 |
|
CursorPosition |
Coordinates - see section 2.2.3.1 |
2 |
|
WindowPosition |
Coordinates - see section 2.2.3.1 |
3 |
|
CursorSize |
Int32 - see section 2.2.5.1.11 |
4 |
|
BufferSize |
Size - see section 2.2.3.2 |
5 |
|
WindowSize |
Size - see section 2.2.3.2 |
6 |
|
MaxWindowSize |
Size - see section 2.2.3.2 |
7 |
|
MaxPhysicalWindowSize |
Size - see section 2.2.3.2 |
8 |
|
WindowTitle |
String - see section 2.2.5.1.1 |
9 |
The Complex Object described in this section SHOULD have no associated type names (section 2.2.5.2.3).
For an example, see section 2.2.2.2.