SetSSHParam Method

Used to write a field to the end of a payload.

Syntax

[VB.NET]
Public Function SetSSHParam(ByVal Payload As String, ByVal FieldType As String, ByVal FieldValue As String) As String

[C#]
public byte[] SetSSHParam(byte[] payload, string fieldType, string fieldValue);

Remarks

This method is used to build the payload portion of an SSH packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.

The following is a list of supported field types and a description of how FieldValue should be encoded:

s	A plaintext string containing the default system encoding of the data.
sb	A string containing the hex encoded data. (eg: "A1B23C")
m	A variable-length large integer, encoded as a textual representation of the value ("1234").
i	A 32-bit integer, encoded as a textual representation of the value (eg: "1234").
l	A 64-bit integer, encoded as a textual representation of the value (eg: "1234").
b	A single byte, encoded as a textual representation of the value (eg: "123").
f	A boolean flag, encoded as a textual representation of the value (eg: 'true' or 'false')

Note: integer values may be encoded in hexadecimal by prefixing "0x" to the beginning of the string, otherwise the value is assumed to be base-10.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

NOTE: This method has a corresponding asynchronous version (SetSSHParamAsync) for use in the WinRT environment.