Changeset 99405 in vbox for trunk/src/VBox/GuestHost/SharedClipboard

Timestamp:

Apr 14, 2023 3:43:12 PM (2 years ago)

Author:

vboxsync

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

156855

Message:

Shared Clipboard/Transfers: Added ShClTransferCreateEx() and some defines for transfer defaults, more documentation for struct typedefs. bugref:9437

File:

• trunk/src/VBox/GuestHost/SharedClipboard/clipboard-transfers.cpp (modified) (3 diffs)

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-transfers.cpp

@@ -1165 +1165 @@
 
 /**
- * Creates a clipboard transfer.
- *
- * @returns VBox status code.
+ * Creates a clipboard transfer, extended version.
+ *
+ * @returns VBox status code.
+ * @param   cbMaxChunkSize      Maximum transfer chunk size (in bytes) to use.
+ * @param   cMaxListHandles     Maximum list entries the transfer can have.
+ * @param   cMaxObjHandles      Maximum transfer objects the transfer can have.
  * @param   ppTransfer          Where to return the created clipboard transfer struct.
  *                              Must be destroyed by ShClTransferDestroy().
  */
-int ShClTransferCreate(PSHCLTRANSFER *ppTransfer)
-{
+int ShClTransferCreateEx(uint32_t cbMaxChunkSize, uint32_t cMaxListHandles, uint32_t cMaxObjHandles,
+                         PSHCLTRANSFER *ppTransfer)
+{
+
+
     AssertPtrReturn(ppTransfer, VERR_INVALID_POINTER);
 
@@ -1197 +1203 @@
     pTransfer->uTimeoutMs     = RT_MS_30SEC;
 #endif
-    pTransfer->cbMaxChunkSize  = _64K; /** @todo Make this configurable. */
-    pTransfer->cMaxListHandles = _4K;  /** @todo Ditto. */
-    pTransfer->cMaxObjHandles  = _4K;  /** @todo Ditto. */
+    pTransfer->cbMaxChunkSize  = cbMaxChunkSize;
+    pTransfer->cMaxListHandles = cMaxListHandles;
+    pTransfer->cMaxObjHandles  = cMaxObjHandles;
 
     pTransfer->pvUser = NULL;
@@ -1226 +1232 @@
     LogFlowFuncLeaveRC(rc);
     return rc;
+}
+
+/**
+ * Creates a clipboard transfer with default settings.
+ *
+ * @returns VBox status code.
+ * @param   ppTransfer          Where to return the created clipboard transfer struct.
+ *                              Must be destroyed by ShClTransferDestroy().
+ */
+int ShClTransferCreate(PSHCLTRANSFER *ppTransfer)
+{
+    return ShClTransferCreateEx(SHCL_TRANSFER_DEFAULT_MAX_CHUNK_SIZE,
+                                SHCL_TRANSFER_DEFAULT_MAX_LIST_HANDLES,
+                                SHCL_TRANSFER_DEFAULT_MAX_OBJ_HANDLES,
+                                ppTransfer);
 }