Changeset 4869

Timestamp:

Aug 24, 2005, 11:57:49 AM (21 years ago)

Author:

Paul Price

Message:

Split psMetadataRemove into two functions

Location:

trunk/doc/pslib

Files:

• ChangeLogSDRS.tex (modified) (2 diffs)
• psLibSDRS.tex (modified) (2 diffs)

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.164 2005-08-24 01:38:16 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.165 2005-08-24 21:57:49 price Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -770 +770 @@
   psXMLDocToFD} to bool (bug 499).
 \item Clarified behaviour of \code{psLogSetDestination} and \code{psTraceSetDestination}.
-\end{itemize}
-
+\item Split \code{psMetadataRemove} into \code{psMetadataRemoveKey} and \code{psMetadataRemoveIndex}.
+\end{itemize}
+

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.326 2005-08-24 01:38:16 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.327 2005-08-24 21:57:49 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -2751 +2751 @@
 
 Items may be removed from the metadata by specifying a key or a
-location in the list.  If the value of \code{name} is \code{NULL}, the
-value of \code{location} is used.  If the value of \code{name} is not
-\code{NULL}, then \code{location} must be set to
-\code{PS_LIST_UNKNOWN}.  If the key matches a metadata item, the item
-is removed from the metadata and \code{true} is returned; otherwise,
-\code{false} is returned.  If the key is not unique, then \emph{all}
-items corresponding to the key are removed, and \code{true} is
-returned.
-%
-\begin{prototype}
-bool psMetadataRemove(psMetadata *md, long location, const char *key);
+location in the list.  For \code{psMetadataRemoveKey}, if the key
+matches a metadata item, the item is removed from the metadata and
+\code{true} is returned; otherwise, \code{false} is returned.  If the
+key is not unique, then \emph{all} items corresponding to the key are
+removed, and \code{true} is returned.  For
+\code{psMetadataRemoveIndex}, the metadata item at the specified
+\code{location} is removed, if valid, and \code{true} is returned;
+otherwise the function returns \code{false}.
+%
+\begin{prototype}
+bool psMetadataRemoveKey(psMetadata *md, const char *key);
+bool psMetadataRemoveIndex(psMetadata *md, int location);
 \end{prototype}