Changeset 13558 in vbox

Timestamp:

Oct 24, 2008 2:31:58 PM (16 years ago)

Author:

vboxsync

Message:

Guest Properties (Main and HostServices): updated API documentation

Location:

trunk

Files:

trunk/include/VBox/HostServices/GuestPropertySvc.h

-              r13557
+              r13558
     /**
+     * Null-separated array of patterns to match the properties against.
+     * Array of patterns to match the properties against, separated by '|'
+     * characters.  For backwards compatibility, '\0' is also accepted
+     * as a separater.
      * (IN pointer)
+     * If no patterns are given then return all.  The list is terminated by an
+     * empty string.
+     * If only a single, empty pattern is given then match all.
      */
     HGCMFunctionParameter patterns;

-              r13436
+              r13558
       <param name="patterns" type="wstring" dir="in">
         <desc>
+          The patterns to match the properties against as a comma-separated
+          string with no spaces.  If this is empty, all properties currently
+          set will be returned.
+          The patterns to match the properties against, separated by '|'
+          characters.  If this is empty or NULL, all properties will match.
         </desc>
       </param>

Note: See TracChangeset for help on using the changeset viewer.