[libpst-commits] r92 - trunk

[Joseph Nahmias]

Author: jello
Date: 2008-07-02 15:01:14 +0000 (Wed, 02 Jul 2008)
New Revision: 92

Modified:
   trunk/libpst.c
Log:
document pst_open()

Index: trunk/libpst.c
===================================================================
--- trunk/libpst.c	(revision 91)
+++ trunk/libpst.c	(revision 92)
@@ -121,6 +121,13 @@ unsigned char comp_enc [] = 
 
 int32_t
 pst_open(pst_file *pf, char *name, char *mode) {
+// Allocates the pst_file structure
+// Opens the PST file
+// Reads in a few members of the pst_file from the file:
+//   size, encryption, ind_type
+//   index1, index1_count
+//   index2, index2_count
+// Initializes the rest of the structure to "safe" values
 
   u_int32_t sig;