PowerTCP Emulation for .NET
MapVtKey Method




VtKey to return the escape sequence or character for.
TerminalType to return the escape sequence for.
Used for VtKey.Up Down Left and Right. Ignored for all other VtKeys.
Returns the relevant escape sequence or character for the specified vtKey and terminalType.
Syntax
Public Shared Function MapVtKey( _
   ByVal vtKey As VtKey, _
   ByVal terminalType As TerminalType, _
   ByVal cursorKeysMode As CursorKeys _
) As Byte()
Dim vtKey As VtKey
Dim terminalType As TerminalType
Dim cursorKeysMode As CursorKeys
Dim value() As Byte
 
value = Vt.MapVtKey(vtKey, terminalType, cursorKeysMode)
public static byte[] MapVtKey( 
   VtKey vtKey,
   TerminalType terminalType,
   CursorKeys cursorKeysMode
)
public: static byte[]* MapVtKey( 
   VtKey vtKey,
   TerminalType terminalType,
   CursorKeys cursorKeysMode
) 
public:
static array<byte>^ MapVtKey( 
   VtKey vtKey,
   TerminalType terminalType,
   CursorKeys cursorKeysMode
) 

Parameters

vtKey
VtKey to return the escape sequence or character for.
terminalType
TerminalType to return the escape sequence for.
cursorKeysMode
Used for VtKey.Up Down Left and Right. Ignored for all other VtKeys.

Return Value

An escape sequence or character that represents the vtKey under the terminalType.
Remarks

The value of Vt.TerminalType is typically used for terminalType, and the value of Vt.CursorKeys is typically used for cursorKeysMode.

Returns null if the vtKey is not available for the specified terminalType. See the 'Emulation Overview' top-level topic for more information.

See Also

Reference

Vt Class
Vt Members


PowerTCP Emulation for .NET Documentation Version 4.7
© 2018 Dart Communications. All Rights Reserved.
Send comments on this topic