Changeset 100566 in vbox for trunk/include

Timestamp:

Jul 13, 2023 6:50:43 PM (17 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Added ShClEventWaitEx() + ShClEventSignalEx() for easier error propagation when waiting for events, plus new error codes VERR_SHCLPB_EVENT_FAILED + VERR_SHCLPB_GUEST_ERROR. bugref:9437

Location:

trunk/include/VBox

Files:

• GuestHost/SharedClipboard.h (modified) (2 diffs)
• err.h (modified) (1 diff)

trunk/include/VBox/GuestHost/SharedClipboard.h

@@ -189 +189 @@
     /** Payload to this event, optional (NULL). */
     PSHCLEVENTPAYLOAD   pPayload;
+    /** Result code (IPRT-style) to assign. */
+    int                 rc;
 } SHCLEVENT;
 /** Pointer to a shared clipboard event. */
@@ -236 +238 @@
 uint32_t ShClEventRetain(PSHCLEVENT pEvent);
 uint32_t ShClEventRelease(PSHCLEVENT pEvent);
+int ShClEventSignalEx(PSHCLEVENT pEvent, int rc, PSHCLEVENTPAYLOAD pPayload);
 int ShClEventSignal(PSHCLEVENT pEvent, PSHCLEVENTPAYLOAD pPayload);
 int ShClEventWait(PSHCLEVENT pEvent, RTMSINTERVAL uTimeoutMs, PSHCLEVENTPAYLOAD *ppPayload);
+int ShClEventWaitEx(PSHCLEVENT pEvent, RTMSINTERVAL uTimeoutMs, int *pRc, PSHCLEVENTPAYLOAD *ppPayload);
 /** @} */
 

trunk/include/VBox/err.h

@@ -3073 +3073 @@
 /** Shared Clipboard transfer ID not found. */
 #define VERR_SHCLPB_TRANSFER_ID_NOT_FOUND           (-7150)
+/** Shared Clipboard guest error. */
+#define VERR_SHCLPB_GUEST_ERROR                     (-7151)
+/** Shared Clipboard event failed error. */
+#define VERR_SHCLPB_EVENT_FAILED                    (-7152)
 /** @} */