Changeset 37375 in vbox for trunk/include/VBox/HostServices

Timestamp:

Jun 8, 2011 10:51:26 AM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

72150

Message:

GuestCtrl: Added APIs for guest directory enumeration, guest file existence and copy from guest support, some API renaming/cleanup (work in progress).

File:

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

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -109 +109 @@
 
 /**
- * Document me.
+ * The guest control callback data header. Must come first
+ * on each callback structure defined below this struct.
  */
 typedef struct VBoxGuestCtrlCallbackHeader
@@ -119 +120 @@
 } CALLBACKHEADER;
 typedef CALLBACKHEADER *PCALLBACKHEADER;
+
+typedef struct VBoxGuestCtrlCallbackDataClientDisconnected
+{
+    /** Callback data header. */
+    CALLBACKHEADER hdr;
+} CALLBACKDATACLIENTDISCONNECTED;
+typedef CALLBACKDATACLIENTDISCONNECTED *PCALLBACKDATACLIENTDISCONNECTED;
 
 /**
@@ -173 +181 @@
 typedef CALLBACKDATAEXECINSTATUS *PCALLBACKDATAEXECINSTATUS;
 
-typedef struct VBoxGuestCtrlCallbackDataClientDisconnected
+typedef struct VBoxGuestCtrlCallbackDataDirOpen
 {
     /** Callback data header. */
     CALLBACKHEADER hdr;
-} CALLBACKDATACLIENTDISCONNECTED;
-typedef CALLBACKDATACLIENTDISCONNECTED *PCALLBACKDATACLIENTDISCONNECTED;
-
-enum
-{
-    /** Magic number for sanity checking the CALLBACKDATACLIENTDISCONNECTED structure. */
-    CALLBACKDATAMAGICCLIENTDISCONNECTED = 0x08041984,
-    /** Magic number for sanity checking the CALLBACKDATAEXECSTATUS structure. */
-    CALLBACKDATAMAGICEXECSTATUS = 0x26011982,
-    /** Magic number for sanity checking the CALLBACKDATAEXECOUT structure. */
-    CALLBACKDATAMAGICEXECOUT = 0x11061949,
-    /** Magic number for sanity checking the CALLBACKDATAEXECIN structure. */
-    CALLBACKDATAMAGICEXECINSTATUS = 0x19091951
+    /** The native node id. */
+    uint32_t u32Handle;
+} CALLBACKDATADIROPEN;
+typedef CALLBACKDATADIROPEN *PCALLBACKDATADIROPEN;
+
+typedef struct VBoxGuestCtrlCallbackDataDirRead
+{
+    /** Callback data header. */
+    CALLBACKHEADER hdr;
+    /** The native node id. */
+    uint64_t u64NodeId;
+    /** The entry name. */
+    char *pszName;
+    /** Size (in bytes) of entry name. */
+    uint32_t cbName;
+} CALLBACKDATADIRREAD;
+typedef CALLBACKDATADIRREAD *PCALLBACKDATADIRREAD;
+
+enum eVBoxGuestCtrlCallbackDataMagic
+{
+    CALLBACKDATAMAGIC_CLIENT_DISCONNECTED = 0x08041984,
+
+    CALLBACKDATAMAGIC_EXEC_STATUS = 0x26011982,
+    CALLBACKDATAMAGIC_EXEC_OUT = 0x11061949,
+    CALLBACKDATAMAGIC_EXEC_IN_STATUS = 0x19091951,
+
+    CALLBACKDATAMAGIC_DIR_OPEN = 0x05031907,
+    CALLBACKDATAMAGIC_DIR_READ = 0x02041932
 };
 
@@ -195 +218 @@
 {
     VBOXGUESTCTRLCALLBACKTYPE_UNKNOWN = 0,
+
     VBOXGUESTCTRLCALLBACKTYPE_EXEC_START = 1,
     VBOXGUESTCTRLCALLBACKTYPE_EXEC_OUTPUT = 2,
-    VBOXGUESTCTRLCALLBACKTYPE_EXEC_INPUT_STATUS = 3
+    VBOXGUESTCTRLCALLBACKTYPE_EXEC_INPUT_STATUS = 3,
+
+    VBOXGUESTCTRLCALLBACKTYPE_DIR_OPEN = 100,
+    VBOXGUESTCTRLCALLBACKTYPE_DIR_READ = 105
 };
 
@@ -209 +236 @@
      */
     HOST_CANCEL_PENDING_WAITS = 0,
+
+    /*
+     * Execution handling.
+     */
+
     /**
      * The host wants to execute something in the guest. This can be a command line
@@ -222 +254 @@
      * new data on stdout/stderr, process terminated etc.
      */
-    HOST_EXEC_GET_OUTPUT = 102
+    HOST_EXEC_GET_OUTPUT = 102,
+
+    /*
+     * Directory handling.
+     */
+
+    /**
+     * Opens a directory for reading.
+     */
+    HOST_DIR_OPEN = 200,
+    /**
+     * Closes a formerly opened directory.
+     */
+    HOST_DIR_CLOSE = 201,
+    /**
+     * Reads the next entry from an open directory.
+     */
+    HOST_DIR_READ = 202
 };
 
@@ -247 +296 @@
      */
     GUEST_DISCONNECTED = 3,
+
+    /*
+     * Process execution.
+     */
+
     /**
      * Guests sends output from an executed process.
@@ -258 +312 @@
      * Guests sends an input status notification to the host.
      */
-    GUEST_EXEC_SEND_INPUT_STATUS = 102
+    GUEST_EXEC_SEND_INPUT_STATUS = 102,
+
+    /*
+     * Directory handling.
+     */
+
+    /**
+     * Guest sends back the directory handle.
+     */
+    GUEST_DIR_SEND_OPEN = 200,
+    /**
+     * Guest sends back the next directory entry.
+     */
+    GUEST_DIR_SEND_READ = 202
 };
 
@@ -401 +468 @@
 } VBoxGuestCtrlHGCMMsgExecStatusIn;
 
+/**
+ * Closes a formerly openend guest directory.
+ */
+typedef struct VBoxGuestCtrlHGCMMsgDirClose
+{
+    VBoxGuestHGCMCallInfo hdr;
+    /** Context ID. */
+    HGCMFunctionParameter context;
+    /** Directory handle to close. */
+    HGCMFunctionParameter handle;
+
+} VBoxGuestCtrlHGCMMsgDirClose;
+
+/**
+ * Opens a guest directory for reading.
+ */
+typedef struct VBoxGuestCtrlHGCMMsgDirOpen
+{
+    VBoxGuestHGCMCallInfo hdr;
+    /** Context ID. */
+    HGCMFunctionParameter context;
+    /** Directory (path) to open. */
+    HGCMFunctionParameter directory;
+    /** Filter (DOS style wildcard). */
+    HGCMFunctionParameter filter;
+    /** Open flags. */
+    HGCMFunctionParameter flags;
+    /** The user name to run the executed command under. */
+    HGCMFunctionParameter username;
+    /** The user's password. */
+    HGCMFunctionParameter password;
+    /** OUT: Handle for opened directory. */
+    HGCMFunctionParameter handle;
+
+} VBoxGuestCtrlHGCMMsgDirOpen;
+
+/**
+ * Reads next entry of an open guest directory.
+ */
+typedef struct VBoxGuestCtrlHGCMMsgDirRead
+{
+    VBoxGuestHGCMCallInfo hdr;
+    /** Context ID. */
+    HGCMFunctionParameter context;
+    /** Directory handle to read from. */
+    HGCMFunctionParameter handle;
+
+} VBoxGuestCtrlHGCMMsgDirRead;
+
 #pragma pack ()