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

Timestamp:

Apr 4, 2005, 5:05:11 PM (21 years ago)

Author:

jhoblitt

Message:

add psMetadataFormatConfig()
add psMetadataWriteConfig()

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.197 2005-04-05 00:48:40 jhoblitt Exp $
+%%% $Id: psLibSDRS.tex,v 1.198 2005-04-05 03:05:11 jhoblitt Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -3938 +3938 @@
 On error, the function shall return \code{NULL}.
 
+It is also useful to be able to convert a \code{psMetadata} structure into the
+Configuration File format for debugging purposes and to enable persistent
+configuration.
+
+\begin{verbatim}
+char *psMetadataFormatConfig(psMetadata *md);
+bool psMetadataWriteConfig(psMetadata *md, const char *filename);
+\end{verbatim}
+
+The \code{psMetadataFormatConfig} function converts a \code{psMetadata}
+structure (including any nested \code{psMetadata}) into a Configuration File
+formatted string.  A \code{NULL} shall be returned on error.  The
+\code{psMetadataWriteConfig} behaves the same as \code{psMetadataFormatConfig}
+except that the string is writen out to \code{filename}.  \code{false} is
+returned on failure.
+
 \paragraph{Comments}