Changeset 8328 in vbox

Timestamp:

Apr 23, 2008 1:17:00 PM (17 years ago)

Author:

vboxsync

Message:

Added missing docs and corrected spelling.

Location:

trunk/src/VBox/Additions/common/VBoxGuest

Files:

• VBoxGuest.cpp (modified) (2 diffs)
• VBoxGuestInternal.h (modified) (1 diff)

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuest.cpp

@@ -521 +521 @@
 
 
-/** @todo XXX: This should later be done as a proper IOCtl request. Currently we call this from Ring-0. */
-int VBoxGuestSetGuestCapabilities(uint32_t u32OrMask, uint32_t u32NotMask)
-{
-    int rc;
+/**
+ * Modifies the guest capabilities.
+ *
+ * Should be called during driver init and termination.
+ *
+ * @returns VBox status code.
+ * @param   fOr             The Or mask (what to enable).
+ * @param   fNot            The Not mask (what to disable).
+ */
+int VBoxGuestSetGuestCapabilities(uint32_t fOr, uint32_t fNot)
+{
     VMMDevReqGuestCapabilities2 *pReq;
-    rc = VbglGRAlloc((VMMDevRequestHeader **)&pReq, sizeof(*pReq), VMMDevReq_SetGuestCapabilities);
+    int rc = VbglGRAlloc((VMMDevRequestHeader **)&pReq, sizeof(*pReq), VMMDevReq_SetGuestCapabilities);
     if (RT_FAILURE(rc))
     {
@@ -534 +541 @@
     }
 
-    pReq->u32OrMask = u32OrMask;
-    pReq->u32NotMask = u32NotMask;
+    pReq->u32OrMask = fOr;
+    pReq->u32NotMask = fNot;
 
     rc = VbglGRPerform(&pReq->header);

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuestInternal.h

@@ -152 +152 @@
 void VBoxGuestDeleteDevExt(PVBOXGUESTDEVEXT pDevExt);
 bool VBoxGuestCommonISR(PVBOXGUESTDEVEXT pDevExt);
-int  VBoxGuestSetGuestCapabilities(uint32_t u32OrMask, uint32_t u32NotMask);
+int  VBoxGuestSetGuestCapabilities(uint32_t fOr, uint32_t fNot);
 
 int  VBoxGuestCreateUserSession(PVBOXGUESTDEVEXT pDevExt, PVBOXGUESTSESSION *ppSession);