Changeset 86:f7714df5165f in xplra

Timestamp:

05/12/13 07:25:45 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Added the documentation of COMMAND_SAVE_SITUTATION

File:

• doc/overview.dox (modified) (2 diffs)

doc/overview.dox

@@ -159 +159 @@
  * \ref command_get_versions "Query the versions of X-Plane, XPLM and XPLRA" | 0x31 | \anchor COMMAND_GET_VERSIONS COMMAND_GET_VERSIONS
  * \ref command_reload_plugins "Reload the plugins in X-Plane" | 0x32 | \anchor COMMAND_RELOAD_PLUGINS COMMAND_RELOAD_PLUGINS
+ * \ref command_save_situation "Save the current situation" | 0x33 | \anchor COMMAND_SAVE_SITUATION COMMAND_SAVE_SITUATION
  * \ref command_show_message "Show a message in X-Plane's window" | 0x41 | \anchor COMMAND_SHOW_MESSAGE COMMAND_SHOW_MESSAGE
  * \ref command_register_hotkeys "Register hotkeys to be listened to" | 0x51 | \anchor COMMAND_REGISTER_HOTKEYS COMMAND_REGISTER_HOTKEYS
@@ -578 +579 @@
  * ---- | ------
  * byte | 0x00 (\ref RESULT_OK)
+ *
+ * \subsection command_save_situation The SAVE_SITUATION command
+ *
+ * This command can be used to save the current situation into a file.
+ * It is available only on X-Plane 10 or later.
+ *
+ * Type | Description
+ * ---- | ------
+ * byte | 0x33 (\ref COMMAND_SAVE_SITUATION)
+ * string | the path of the file to save the situation into, relative to the X-Plane directory
+ *
+ * If successful, the reply is the following:
+ *
+ * Type | Description
+ * ---- | ------
+ * byte | 0x00 (\ref RESULT_OK)
+ *
+ * If an error was encountered, the reply is the following (no error could be produced yet,
+ * but it might fail).
+ *
+ * Type | Description
+ * ---- | ------
+ * byte | 0xff (\ref RESULT_OTHER_ERROR)
  *
  * \subsection command_get_versions The GET_VERSIONS command