Changeset 81269 in vbox for trunk/include/VBox/GuestHost

Timestamp:

Oct 14, 2019 6:28:34 PM (5 years ago)

Author:

vboxsync

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

133964

Message:

Shared Clipboard/Transfers: Implemented transfer cancellation support for the Windows shell.

File:

• trunk/include/VBox/GuestHost/SharedClipboard-win.h (modified) (4 diffs)

trunk/include/VBox/GuestHost/SharedClipboard-win.h

@@ -170 +170 @@
     enum Status
     {
+        /** The object is uninitialized (not ready). */
         Uninitialized = 0,
-        Initialized
+        /** The object is initialized and ready to use. */
+        Initialized,
+        /** The operation has been successfully completed. */
+        Completed,
+        /** The operation has been canceled. */
+        Canceled,
+        /** An (unrecoverable) error occurred. */
+        Error
     };
 
@@ -218 +226 @@
     static DECLCALLBACK(int) readThread(RTTHREAD ThreadSelf, void *pvUser);
 
-    static const char* ClipboardFormatToString(CLIPFORMAT fmt);
+    static void logFormat(CLIPFORMAT fmt);
 
 protected:
@@ -249 +257 @@
     typedef std::vector<FSOBJENTRY> FsObjEntryList;
 
+    /** The object's current status. */
     Status                      m_enmStatus;
+    /** The object's current reference count. */
     LONG                        m_lRefCount;
+    /** How many formats have been registered. */
     ULONG                       m_cFormats;
     LPFORMATETC                 m_pFormatEtc;
     LPSTGMEDIUM                 m_pStgMedium;
+    /** Pointer to the associated transfer object being handled. */
     PSHCLTRANSFER               m_pTransfer;
+    /** Current stream object being used. */
     IStream                    *m_pStream;
+    /** Current object index being handled by the data object.
+     *  This is needed to create the next IStream object for e.g. the next upcoming file/dir/++ in the transfer. */
     ULONG                       m_uObjIdx;
     /** List of (cached) file system objects. */
@@ -265 +280 @@
     /** Event being triggered when the transfer has been completed. */
     RTSEMEVENT                  m_EventTransferComplete;
+    /** Registered format for CFSTR_FILEDESCRIPTORA. */
     UINT                        m_cfFileDescriptorA;
+    /** Registered format for CFSTR_FILEDESCRIPTORW. */
     UINT                        m_cfFileDescriptorW;
+    /** Registered format for CFSTR_FILECONTENTS. */
     UINT                        m_cfFileContents;
+    /** Registered format for CFSTR_PERFORMEDDROPEFFECT. */
+    UINT                        m_cfPerformedDropEffect;
 };