Changeset 9917 in vbox

Timestamp:

Jun 25, 2008 1:57:56 PM (17 years ago)

Author:

vboxsync

Message:

Corrected hungarian spelling and added a todo.

File:

• trunk/src/VBox/HostServices/SharedInfoServices/service.cpp (modified) (18 diffs)

trunk/src/VBox/HostServices/SharedInfoServices/service.cpp

@@ -34 +34 @@
  * Since the CFGM APIs are single threaded, the creator must also ensure that
  * no-one else accesses the configuration node while the service is running.
- * 
+ *
  * If this service is extended to deal with new requests it would probably be a
  * good idea to split it up into several files.
@@ -111 +111 @@
     }
 
-    /** 
+    /**
      * @copydoc VBOXHGCMSVCHELPERS::pfnConnect
      * Stub implementation of pfnConnect and pfnDisconnect.
@@ -122 +122 @@
     }
 
-    /** 
+    /**
      * @copydoc VBOXHGCMSVCHELPERS::pfnCall
      * Wraps to the call member function
@@ -139 +139 @@
     }
 
-    /** 
-     * @copydoc VBOXHGCMSVCHELPERS::pfnHostCall 
+    /**
+     * @copydoc VBOXHGCMSVCHELPERS::pfnHostCall
      * Wraps to the hostCall member function
      */
@@ -154 +154 @@
 private:
     int getKey(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
-    int validateGetKey(const char *pcKey, uint32_t cbKey, char *pcValue, uint32_t cbValue);
+    int validateGetKey(const char *pszKey, uint32_t cbKey, char *pszValue, uint32_t cbValue);
     int setKey(uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
-    int validateSetKey(const char *pcKey, uint32_t cbKey, char *pcValue, uint32_t cbValue);
+    int validateSetKey(const char *pszKey, uint32_t cbKey, char *pszValue, uint32_t cbValue);
     void call (VBOXHGCMCALLHANDLE callHandle, uint32_t u32ClientID,
                void *pvClient, uint32_t eFunction, uint32_t cParms,
@@ -167 +167 @@
  * Retrieve a value from the guest registry by key, checking the validity
  * of the arguments passed.
- * 
+ *
  * @returns iprt status value
  * @param   cParms  the number of HGCM parameters supplied
@@ -176 +176 @@
 {
     int rc = VINF_SUCCESS;
-    char *pszKey, *pcValue;
+    char *pszKey, *pszValue;
     uint32_t cbKey, cbValue;
     size_t cbValueActual;
@@ -189 +189 @@
         rc = VBoxHGCMParmPtrGet(&paParms[0], (void **) &pszKey, &cbKey);
     if (RT_SUCCESS(rc))
-        rc = VBoxHGCMParmPtrGet(&paParms[1], (void **) &pcValue, &cbValue);
-    if (RT_SUCCESS(rc))
-        rc = validateGetKey(pszKey, cbKey, pcValue, cbValue);
+        rc = VBoxHGCMParmPtrGet(&paParms[1], (void **) &pszValue, &cbValue);
+    if (RT_SUCCESS(rc))
+        rc = validateGetKey(pszKey, cbKey, pszValue, cbValue);
     if (RT_SUCCESS(rc))
         rc = CFGMR3QuerySize(mpNode, pszKey, &cbValueActual);
@@ -199 +199 @@
         rc = VINF_BUFFER_OVERFLOW;
     if (RT_SUCCESS(rc) && (rc != VINF_BUFFER_OVERFLOW))
-        rc = CFGMR3QueryString(mpNode, pszKey, pcValue, cbValue);
+        rc = CFGMR3QueryString(mpNode, pszKey, pszValue, cbValue);
     if (RT_SUCCESS(rc) && (rc != VINF_BUFFER_OVERFLOW))
-        Log2(("Queried string %s, rc=%Rrc, value=%.*s\n", pszKey, rc, cbValue, pcValue));
+        Log2(("Queried string %s, rc=%Rrc, value=%.*s\n", pszKey, rc, cbValue, pszValue));
     else if (VERR_CFGM_VALUE_NOT_FOUND == rc)
     {
@@ -218 +218 @@
  *
  * @returns IPRT status code
- * @param   pcKey     the key passed by the guest
- * @param   cbKey     the number of bytes in the array cbKey
- * @param   pcValue   the array to store the key into
+ * @param   pszKey    the key passed by the guest
+ * @param   cbKey     the number of bytes pszKey points to, including the terminating '\0'
+ * @param   pszValue  the buffer to store the key name into
  * @param   cbValue   the size of the array for storing the key value
  * @thread  HGCM
  */
-int Service::validateGetKey(const char *pcKey, uint32_t cbKey, char *pcValue, uint32_t cbValue)
+int Service::validateGetKey(const char *pszKey, uint32_t cbKey, char *pszValue, uint32_t cbValue)
 {
     LogFlowFunc(("cbKey=%d, cbValue=%d\n", cbKey, cbValue));
@@ -235 +235 @@
         rc = VERR_INVALID_PARAMETER;
     /* Only accept names in printable ASCII without spaces */
-    for (count = 0; (count < cbKey) && (pcKey[count] != '\0'); ++count)
-        if ((pcKey[count] < 33) || (pcKey[count] > 126))
+    for (count = 0; (count < cbKey) && (pszKey[count] != '\0'); ++count)
+        if ((pszKey[count] < 33) || (pszKey[count] > 126))
             rc = VERR_INVALID_PARAMETER;
     if (RT_SUCCESS(rc) && (count == cbKey))
@@ -245 +245 @@
 
     if (RT_SUCCESS(rc))
-        LogFlow(("    pcKey=%s\n", pcKey));
+        LogFlow(("    pszKey=%s\n", pszKey));
     LogFlowFunc(("returning %Rrc\n", rc));
     return rc;
@@ -254 +254 @@
  * Set a value in the guest registry by key, checking the validity
  * of the arguments passed.
- * 
+ *
  * @returns iprt status value
  * @param   cParms  the number of HGCM parameters supplied
@@ -306 +306 @@
  *
  * @returns IPRT status code
- * @param   pcKey     the key passed by the guest
- * @param   cbKey     the number of bytes in the array cbKey
- * @param   pcValue   the value to store in the key
- * @param   cbValue   the number of bytes in the array pcValue
+ * @param   pszKey    the key passed by the guest
+ * @param   cbKey     the number of bytes in the buffer pszKey points to
+ * @param   pszValue  the value to store in the key
+ * @param   cbValue   the number of bytes in the buffer pszValue points to
  * @thread  HGCM
  */
-int Service::validateSetKey(const char *pcKey, uint32_t cbKey, char *pcValue,
+int Service::validateSetKey(const char *pszKey, uint32_t cbKey, char *pszValue,
                                    uint32_t cbValue)
 {
@@ -323 +323 @@
     if (cbKey < sizeof(VBOX_SHARED_INFO_KEY_PREFIX))
         rc = VERR_INVALID_PARAMETER;
+    /** @todo duplicate check in validateGetKey, use separate method. mixing unsigned and uint32_t. */
     /* Only accept names in printable ASCII without spaces */
-    for (count = 0; (count < cbKey) && (pcKey[count] != '\0'); ++count)
-        if ((pcKey[count] < 33) || (pcKey[count] > 126))
+    for (count = 0; (count < cbKey) && (pszKey[count] != '\0'); ++count)
+        if ((pszKey[count] < 33) || (pszKey[count] > 126))
             rc = VERR_INVALID_PARAMETER;
     if (RT_SUCCESS(rc) && (count == cbKey))
@@ -337 +338 @@
         /* Validate the format of the value. */
         /* Only accept values in printable ASCII without spaces */
-        for (count = 0; (count < cbValue) && (pcValue[count] != '\0'); ++count)
-            if ((pcValue[count] < 33) || (pcValue[count] > 126))
+        for (count = 0; (count < cbValue) && (pszValue[count] != '\0'); ++count)
+            if ((pszValue[count] < 33) || (pszValue[count] > 126))
                 rc = VERR_INVALID_PARAMETER;
         if (RT_SUCCESS(rc) && (count == cbValue))
@@ -348 +349 @@
 
     if (RT_SUCCESS(rc))
-        LogFlow(("    pcKey=%s, pcValue=%s\n", pcKey, cbValue > 0 ? pcValue : NULL));
+        LogFlow(("    pszKey=%s, pszValue=%s\n", pszKey, cbValue > 0 ? pszValue : NULL));
     LogFlowFunc(("returning %Rrc\n", rc));
     return rc;
@@ -360 +361 @@
  *          handled synchronously.  If needed, we will add a request handler
  *          thread in future for those which do.
- *          
+ *
  * @thread  HGCM
  */