Changeset 9538 for trunk/psLib/src/sys/psSlurp.h

Timestamp:

Oct 13, 2006, 11:13:48 AM (20 years ago)

Author:

Paul Price

Message:

Synchronising with SDRS, and cleaning up:

• Replaced is_psType() with PS_ASSERT_PTR() throughout psLib.
• Changed "char *" to "psString" where appropriate in psDB and a few other places (to indicate pointers on the PS memory system).
• Removed psLogArguments and psTraceArguments (functionality in psArgumentVerbosity).
• Renamed psMetadataLookupMD to psMetadataLookupMetadata (it was about time...). Similarly with the psPolynomial?D{From,To}MD functions.
• Removed psMetadataRemove() since it is ambiguous about what's removed --- use psMetadataRemove{Key,Index}.
• psArrayRemoveByPos --> psArrayRemoveIndex
• psArrayRemove --> psArrayRemoveData

File:

• trunk/psLib/src/sys/psSlurp.h (modified) (1 diff)

trunk/psLib/src/sys/psSlurp.h

@@ +1 @@
+#ifndef PS_SLURP_H
+#define PS_SLURP_H
+
 #include <stdio.h>
-#include <pslib.h>
+#include "psString.h"
 
-psString psSlurpFD(int fd);
-psString psSlurpFile(FILE *stream);
+
+// Read ("slurp") a file (specified by file descriptor)
+// and return a string containing the entire file.
+psString psSlurpFD(int fd               // File descriptor to read
+                  );
+
+// Read ("slurp") a file (specified by file stream)
+// and return a string containing the entire file.
+psString psSlurpFile(FILE *stream       // File stream to read
+                    );
+
+
+#endif