Changeset 68476 in vbox for trunk/include/VBox/VBoxGuestLib.h

Timestamp:

Aug 18, 2017 4:33:55 PM (8 years ago)

Author:

vboxsync

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

117622

Message:

VBoxGuestLib/HGCM.cpp: cleanups (this is ring-0 code affecting shared folders only)

File:

• trunk/include/VBox/VBoxGuestLib.h (modified) (5 diffs)

trunk/include/VBox/VBoxGuestLib.h

@@ -305 +305 @@
  * Connect to a service.
  *
- * @param pHandle     Pointer to variable that will hold a handle to be used
- *                    further in VbglHGCMCall and VbglHGCMClose.
- * @param pData       Connection information structure.
- *
- * @return VBox status code.
- */
-DECLVBGL(int) VbglHGCMConnect (VBGLHGCMHANDLE *pHandle, VBoxGuestHGCMConnectInfo *pData);
+ * @param pHandle           Pointer to variable that will hold a handle to be used
+ *                          further in VbglHGCMCall and VbglHGCMClose.
+ * @param pszServiceName    The service to connect to.
+ * @param pidClient         Where to return the client ID for the connection.
+ *
+ * @return VBox status code.
+ *
+ * @todo consider baking the client Id into the handle.
+ */
+DECLVBGL(int) VbglR0HGCMConnect(VBGLHGCMHANDLE *pHandle, const char *pszServiceName, HGCMCLIENTID *pidClient);
 
 /**
@@ -317 +320 @@
  *
  * @param handle      Handle of the connection.
- * @param pData       Disconnect request information structure.
- *
- * @return VBox status code.
- */
-DECLVBGL(int) VbglHGCMDisconnect (VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData);
+ * @param idClient    The ID of the client connection.
+ *
+ * @return VBox status code.
+ *
+ * @todo consider baking the client Id into the handle.
+ */
+DECLVBGL(int) VbglR0HGCMDisconnect(VBGLHGCMHANDLE handle, HGCMCLIENTID idClient);
 
 /**
@@ -332 +337 @@
  * @return VBox status code.
  */
-DECLVBGL(int) VbglHGCMCall (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
+DECLVBGL(int) VbglR0HGCMCall(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
 
 /**
@@ -344 +349 @@
  * @return VBox status code.
  */
-DECLVBGL(int) VbglHGCMCallUserData (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
+DECLVBGL(int) VbglR0HGCMCallUserData(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData);
 
 /**
@@ -356 +361 @@
  * @return VBox status code.
  */
-DECLVBGL(int) VbglHGCMCallTimed(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
+DECLVBGL(int) VbglR0HGCMCallTimed(VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfoTimed *pData, uint32_t cbData);
 /** @} */