Changeset 102835 in vbox for trunk

Timestamp:

Jan 11, 2024 12:07:34 PM (13 months ago)

Author:

vboxsync

Message:

Guest Control/GuestControlSvc.h: Docs.

File:

• trunk/include/VBox/HostServices/GuestControlSvc.h (modified) (10 diffs)

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -110 +110 @@
 /**
  * Structure for low level HGCM host callback from
- * the guest. No deep copy. */
+ * the guest. No deep copy.
+ */
 typedef struct VBOXGUESTCTRLHOSTCALLBACK
 {
@@ -210 +211 @@
     /**
      * Removes a file on the guest.
+     *
+     * @since 7.1
      */
     HOST_MSG_FILE_REMOVE = 273,
     /**
      * Opens (creates) a directory on the guest.
+     *
+     * @since 7.1
      */
     HOST_MSG_DIR_OPEN = 310,
     /**
      * Closes a directory on the guest.
+     *
+     * @since 7.1
      */
     HOST_MSG_DIR_CLOSE = 311,
     /**
      * Reads the next directory entry on the guest.
+     *
+     * @since 7.1
      */
     HOST_MSG_DIR_READ = 312,
     /**
      * Rewinds and restarts the directory reading on the guest.
+     *
+     * @since 7.1
      */
     HOST_MSG_DIR_REWIND = 313,
     /**
      * Creates a directory on the guest.
+     *
+     * @since 7.1
      */
     HOST_MSG_DIR_CREATE = 314,
@@ -235 +248 @@
      * Lists one or multiple directory entries at once.
      *
-     * @since   7.1
+     * @since 7.1
      */
     HOST_MSG_DIR_LIST = 315,
@@ -262 +275 @@
     /**
      * Retrieves information about a file system object.
+     *
+     * @since 7.1
      */
     HOST_MSG_FS_OBJ_QUERY_INFO = 334,
     /**
      * Creates a temporary file or directory.
+     *
+     * @since 7.1
      */
     HOST_MSG_FS_CREATE_TEMP = 335,
     /**
      * Retrieves information about a guest file system.
+     *
+     * @since 7.1
      */
     HOST_MSG_FS_QUERY_INFO = 336,
@@ -276 +295 @@
      * Retrieves the currently accessible mount points from the guest.
      *
-     * @since   7.1
+     * @since 7.1
      */
     HOST_MSG_MOUNT_POINTS = 337,
@@ -1156 +1175 @@
 #endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
 
+/**
+ * Renames a path on the guest.
+ */
 typedef struct HGCMMsgPathRename
 {
@@ -1169 +1191 @@
 } HGCMMsgPathRename;
 
+/**
+ * Retrieves the user's personal documents directory from the guest.
+ */
 typedef struct HGCMMsgPathUserDocuments
 {
@@ -1176 +1201 @@
 } HGCMMsgPathUserDocuments;
 
+/**
+ * Retrieves the user's home directory from the guest.
+ */
 typedef struct HGCMMsgPathUserHome
 {
@@ -1543 +1571 @@
 ******************************************************************************/
 
+/**
+ * Reply from a guest file operation.
+ */
 typedef struct HGCMReplyFileNotify
 {
@@ -1599 +1630 @@
 } HGCMReplyFileNotify;
 
+/**
+ * Reply from a guest directory operation.
+ */
 typedef struct HGCMReplyDirNotify
 {