Changeset 215 for trunk/include

Timestamp:

03/27/11 21:46:11 (14 years ago)

Author:

tim

Message:

improvements to smoketest script, additional test case
added a function to get a key's parent in both regfi and pyregfi
bug fixes

File:

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

trunk/include/regfi.h

@@ -666 +666 @@
   uint8_t* name_raw;
 
-  /** Virutal offset of parent key */
+  /** Virtual offset of parent key */
   uint32_t parent_off;
 
-  /** Virutal offset of classname key */
+  /** Virtual offset of classname key */
   uint32_t classname_off;
   
@@ -952 +952 @@
 
 
-/* Dispose of previously parsed records */
+/** Fetches a hive's root key.
+ *
+ * @return Returns the root key or NULL on failure.  Key must be freed using
+ *         @ref regfi_free_record.
+ *
+ * @ingroup regfiBase
+ */
+_EXPORT
+const REGFI_NK*       regfi_get_rootkey(REGFI_FILE* file);
+
 
 /** Frees a record previously returned by one of the API functions.
@@ -962 +971 @@
  * convenience.  Since records returned previously must not be modified by users
  * of the API due to internal caching, these are returned as const, so this
- * function is const to make passing back in easy.
+ * function is const to make passing those records back easy.
  *
  * @ingroup regfiBase
@@ -1110 +1119 @@
                                 uint32_t index);
 
+
+
+/** Uses a key's parent_off reference to retrieve it's parent.
+ *
+ * @param file  the file from which key is derived
+ * @param key   the key whose parent is desired
+ *
+ * @return the requested subkey or NULL on error.
+ *
+ * @ingroup regfiBase
+ */
+_EXPORT
+const REGFI_NK* regfi_get_parentkey(REGFI_FILE* file, const REGFI_NK* key);
 
 
@@ -1345 +1367 @@
 /******************************************************************************/
 
-/** Loads a key at a given file offset along with associated data structures.
+/** Loads a key and associated data structures given a file offset.
  *
  * XXX: finish documenting
@@ -1353 +1375 @@
 _EXPORT
 REGFI_NK* regfi_load_key(REGFI_FILE* file, uint32_t offset, 
-                             REGFI_ENCODING output_encoding, 
-                             bool strict);
+                         REGFI_ENCODING output_encoding, 
+                         bool strict);
 
 
@@ -1584 +1606 @@
 
 /******************************************************************************/
-/*    Private Functions                                                       */
-/******************************************************************************/
-REGFI_NK*             regfi_rootkey(REGFI_FILE* file);
-
+/*    Private (and undocumented) Functions                                    */
+/******************************************************************************/
 off_t                 regfi_raw_seek(REGFI_RAW_FILE* self, 
                                      off_t offset, int whence);