Changeset 8770 for trunk/doc/pslib/psLibSDRS.tex

Timestamp:

Sep 7, 2006, 12:00:34 PM (20 years ago)

Author:

jhoblitt

Message:

change psMetadataConfigParse() to operate on strings instead of files
add psMetadataConfigRead()

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (3 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.427 2006-09-07 21:50:57 jhoblitt Exp $
+%%% $Id: psLibSDRS.tex,v 1.428 2006-09-07 22:00:34 jhoblitt Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -3075 +3075 @@
 
 \begin{prototype}
-psMetadata *psMetadataConfigParse(psMetadata *md, unsigned int *nFail, const char *filename, bool overwrite);
-psMetadata *psMetadataConfigParseStr(psMetadata *md, unsigned int *nFail, const char *str, bool overwrite);
+psMetadata *psMetadataConfigParse(psMetadata *md, unsigned int *nFail, const char *str, bool overwrite);
+psMetadata *psMetadataConfigRead(psMetadata *md, unsigned int *nFail, const char *filename, bool overwrite);
 \end{prototype}
 
 Given a metadata container, \code{md}, and the name of a configuration
-file, \code{filename}, \code{psMetadataConfigParse} shall parse the
-configuration file, placing the contained key/type/value/comment quads
+file, \code{str}, \code{psMetadataConfigParse} shall parse the
+configuration fstring, placing the contained key/type/value/comment quads
 into the metadata, and returning a pointer to the metadata structure.
 The number of lines that failed to parse is returned in \code{nFail}.
@@ -3088 +3088 @@
 If the metadata container is \code{NULL}, it shall be allocated.  
 
-\code{psMetadataConfigParseStr} is identical in behavor as
-\code{psMetadataConfigParse} except that it parses from a string (\code{str})
-instead of from a file.
-
-On error, the function shall return \code{NULL}.
+\code{psMetadataConfigRead} is identical in behavor to
+\code{psMetadataConfigParse} except that it parses from a file
+(\code{filename}) instead of from a string.
+
+On error, these functions shall return \code{NULL}.
 
 It is also useful to be able to convert a \code{psMetadata} structure into the