View source for IS SSH

== Introduction ==

The '''S'''creen'''SH'''ot packet is used to record screenshots. It is also sent by LFS after a screenshot request to return an error code.

{| class="wikitable"
|+ IS_SSH packet properties
|-
| byte || Size || 40
|-
| byte || Type || ISP_SSH
|-
| byte || ReqI || request: non-zero / reply: same value returned
|-
| byte || Error || 0 = OK / other values are listed below
|-
| byte || Sp0 || 0
|-
| byte || Sp1 || 0
|-
| byte || Sp2 || 0
|-
| byte || Sp3 || 0
|-
| char || Name[32] || name of screenshot file - last byte must be zero
|}

== Packet Details ==

=== Size ===

The size of the packet is always 40 bytes.

=== Type ===

The packet type from the [[InSim_enumerations#ISP|ISP_]] enumeration, always ISP_SSH.

=== ReqI ===

ReqI must be non-zero when sending the packet, LFS replies with the same value.

=== Error ===

An error code from the [[InSim_enumerations#SSH|SSH_]] enumeration:
* SSH_OK: OK, completed instruction
* SSH_DEDICATED: can't save a screenshot - dedicated host
* SSH_CORRUPTED: corrupted screenshot (e.g. name does not end with zero byte)
* SSH_NO_SAVE: could not save the screenshot

=== Name ===

The screenshot's name, without extension.

[[Category:InSim packets]]