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

Timestamp:

Jun 1, 2005, 6:13:41 PM (21 years ago)

Author:

jhoblitt

Message:

add PS_META_NULL

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.257 2005-06-02 00:58:26 jhoblitt Exp $
+%%% $Id: psLibSDRS.tex,v 1.258 2005-06-02 04:13:41 jhoblitt Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -4078 +4078 @@
 \begin{datatype}
 typedef enum {                          ///< option flags for psMetadata functions
-    PS_META_DEFAULT,                    ///< default behavior (0x0000) for use in mode above
-    PS_META_REPLACE,                    ///< allow entry to be replaced
-    PS_META_DUPLICATE_OK,               ///< allow entry to be replaced
+    PS_META_DEFAULT         = 0,        ///< default behavior (0x0000) for use in mode above
+    PS_META_REPLACE         = 0x1000000 ///< allow entry to be replaced
+    PS_META_DUPLICATE_OK    = 0x2000000 ///< allow duplicate entries
+    PS_META_NULL            = 0x4000000 ///< psMetadataItem.data is a NULL value
 } psMetadataFlags;
 \end{datatype}
@@ -4105 +4106 @@
 contain both the existing item and the new item.  The original entry's
 location on the psMetadata.list must be maintained.
+
+\code{PS_META_NULL}:  Indicates that \code{psMetadataItem.data} should be
+ignored and that the the current value is ``NULL'' or undefined.  The
+\code{psMetadataItem} must have a proper \code{type} set and it's \code{data}
+field shall have a valid value.  e.g. A \code{type} of \code{PS_META_STR} would
+require that 's \code{data} is set to \code{NULL}.
 
 There are several of cases to handle for duplication of an existing