Changeset 75747 in vbox for trunk/src/VBox/Main/include

Timestamp:

Nov 26, 2018 6:54:55 PM (6 years ago)

Author:

vboxsync

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

126948

Message:

HGCM: Continue with getting VERR_CANCELLED to the service when the guest has cancelled (or canceled if you prefer) the command.

File:

• trunk/src/VBox/Main/include/HGCMThread.h (modified) (8 diffs)

trunk/src/VBox/Main/include/HGCMThread.h

@@ -123 +123 @@
 /** Initialize threads.
  *
- * @return VBox error code
+ * @return VBox status code.
  */
 int hgcmThreadInit(void);
@@ -141 +141 @@
  *                          NULL if no stats.
  *
- * @return VBox error code
+ * @return VBox status code.
  */
 int hgcmThreadCreate(HGCMThread **ppThread, const char *pszThreadName, PFNHGCMTHREAD pfnThread, void *pvUser,
@@ -151 +151 @@
  *                      consumed.
  *
- * @return VBox error code
+ * @return VBox status code.
  */
 int hgcmThreadWait(HGCMThread *pThread);
@@ -162 +162 @@
  * @param pfnNewMessage New message allocation callback.
  *
- * @return VBox error code
+ * @return VBox status code.
  */
 int hgcmMsgAlloc(HGCMThread *pThread, HGCMMsgCore **ppHandle, uint32_t u32MsgId, PFNHGCMNEWMSGALLOC pfnNewMessage);
@@ -171 +171 @@
  * @param pfnCallback   Message completion callback.
  *
- * @return VBox error code
+ * @return VBox status code.
  * @retval VINF_HGCM_ASYNC_EXECUTE on success.
  *
@@ -184 +184 @@
  * @param pMsg          The message.  Reference will be consumed!
  *
- * @return VBox error code
+ * @return VBox status code.
  *
  * @thread any
@@ -196 +196 @@
  * @param ppMsg         Where to store returned message pointer.
  *
- * @return VBox error code
+ * @return VBox status code.
  *
  * @thread worker thread
@@ -206 +206 @@
  *
  * @param pMsg          Processed message pointer.
- * @param result        Result code, VBox erro code.
- *
- * @return VBox error code
+ * @param result        Result code, VBox status code.
+ *
+ * @return Restricted set of VBox status codes when guest call message:
+ * @retval VINF_SUCCESS on success
+ * @retval VERR_CANCELLED if the request was cancelled.
+ * @retval VERR_ALREADY_RESET if the VM is resetting.
+ * @retval VERR_NOT_AVAILABLE if HGCM has been disconnected from the VMMDev
+ *         (shouldn't happen).
  *
  * @thread worker thread
  */
-void hgcmMsgComplete(HGCMMsgCore *pMsg, int32_t result);
+int hgcmMsgComplete(HGCMMsgCore *pMsg, int32_t result);