Changeset 252 for trunk/include

Timestamp:

05/08/11 13:33:49 (13 years ago)

Author:

tim

Message:

updated pyregfi to work with regfi changes
renamed some functions for more clarity
fixed some issues related to talloc_reference

File:

• trunk/include/regfi.h (modified) (6 diffs)

trunk/include/regfi.h

@@ -1013 +1013 @@
  * Adds an extra internal reference to specified record, making it necessary to
  * call regfi_free_record on it an additional time before it is freed.  This is
- * useful in cases where multiple threads/structures need access to a record, 
+ * useful in cases where multiple threads/structures need access to a shared record,
  * without requiring them to be in sync with when it is freed.
  *
@@ -1022 +1022 @@
  *        REGFI_SK, REGFI_DATA, and REGFI_CLASSNAME records.
  *
- * @return true on success, false otherwise
- *
- * @ingroup regfiBase
- */
-_EXPORT()
-bool regfi_reference_record(REGFI_FILE* file, const void* record);
+ * @return Updated record pointer on success, NULL otherwise
+ *
+ * @note Be sure to use the returned record for further access to the structure
+ *       instead of the previous version of the pointer.  E.g.:
+ *       @code 
+ *       myKey = (const REGFI_NK*)regfi_reference_record(myFile, myKey);
+ *       @endcode
+ *
+ * @ingroup regfiBase
+ */
+_EXPORT()
+const void* regfi_reference_record(REGFI_FILE* file, const void* record);
 
 
@@ -1289 +1295 @@
  */
 _EXPORT()
-bool regfi_iterator_walk_path(REGFI_ITERATOR* i, const char** path);
+bool regfi_iterator_descend(REGFI_ITERATOR* i, const char** path);
 
 
@@ -1413 +1419 @@
 
 
-/** Returns the full path where the iterator is currently located as a list 
- *  of NK records
+/** Returns the current key and all parent keys as a list of NK records
  *
  * @param i     the iterator
@@ -1420 +1425 @@
  * @return An array of NK record pointers terminated by a NULL pointer.  
  *         This array may be passed directly to regfi_free_record to free
- *         the entire array.  
+ *         the entire array.
  *
  * @note In order to use an element of the array independently from the 
@@ -1430 +1435 @@
  */
 _EXPORT()
-const REGFI_NK** regfi_iterator_cur_path(REGFI_ITERATOR* i);
+const REGFI_NK** regfi_iterator_ancestry(REGFI_ITERATOR* i);