Difference between revisions of "IS SSH"

From LFS Manual
Jump to navigationJump to search
(Created page with "== 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="wiki...")
 
 
Line 1: Line 1:
== Introduction ==
+
{{Infobox InSim packet
 +
| description  = Take a screenshot, or get a screenshot report
 +
| size          = 40
 +
| type_key      = ISP_SSH
 +
| type_value    = 49
 +
| direction    = in-out
 +
| prev          = [[IS_RIP]]
 +
| next          = [[IS_CON]]
 +
}}
  
 
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.
 
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.
 +
 +
== Packet details ==
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 24: Line 34:
 
| char || Name[32] || name of screenshot file - last byte must be zero
 
| char || Name[32] || name of screenshot file - last byte must be zero
 
|}
 
|}
 
== Packet Details ==
 
  
 
=== Size ===
 
=== Size ===
Line 50: Line 58:
  
 
The screenshot's name, without extension.
 
The screenshot's name, without extension.
 +
 +
{{InSim packets}}
  
 
[[Category:InSim packets]]
 
[[Category:InSim packets]]

Latest revision as of 11:29, 14 February 2026

IS_SSH
Take a screenshot, or get a screenshot report
Overview
Size 40
Type ISP_SSH (49)
Usage both ways
Previous packet
IS_RIP
Next packet
IS_CON

The ScreenSHot packet is used to record screenshots. It is also sent by LFS after a screenshot request to return an error code.

Packet details

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

Size

The size of the packet is always 40 bytes.

Type

The packet type from the 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 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.


Initialisation IS_ISI
Version Information IS_VER
General Purpose IS_TINY · IS_SMALL · IS_TTC
State Reporting and Requests IS_STA · IS_SFP · IS_ISM
Text Messages and Key Presses IS_SCH · IS_MSO · IS_III · IS_MST · IS_MTC · IS_MSX · IS_MSL
Voting IS_VTN
Race Tracking IS_RST · IS_REO
Autocross IS_AXI · IS_AXO · IS_UCO · IS_OCO · IS_AXM
Connection Tracking IS_NCN · IS_CNL · IS_CPR · IS_ACR · IS_NCI · IS_SLC · IS_CIM
Car Tracking IS_NPL · IS_PLP · IS_PLL · IS_LAP · IS_SPX · IS_PIT · IS_PSF · IS_PLA · IS_PEN · IS_TOC · IS_FLG · IS_PFL · IS_FIN · IS_RES · IS_NLP · IS_MCI · IS_CRS · IS_CON · IS_OBH · IS_HLV · IS_CSC
Camera Control IS_SCC · IS_CPP
Replay Control IS_RIP
Screenshots IS_SSH
InSim Buttons IS_BFN · IS_BTN · IS_BTC · IS_BTT
AI Control IS_AIC · IS_AII
Other packets IS_MOD · IS_CCH · IS_PLC · IS_HCP · IS_JRR · IS_MAL · IS_PLH · IS_IPB