store: Added sdb_store_clear().

[sysdb.git] / src / include / core / data.h

diff --git a/src/include/core/data.h b/src/include/core/data.h
index 01d323b122d6ca25babc161ade270f4b05c60ced..0b4b2e7419312e10d68f9725d7db061dea9d0d14 100644 (file)
--- a/src/include/core/data.h
+++ b/src/include/core/data.h
@@ -93,7 +93,7 @@ sdb_data_copy(sdb_data_t *dst, const sdb_data_t *src);
 /*
  * sdb_data_free_datum:
  * Free any dynamic memory referenced by the specified datum. Does not free
- * the memory allocated for the sdb_data_t object itself. This function must
+ * the memory allocated by the sdb_data_t object itself. This function must
  * not be used if any static or stack memory is referenced from the data
  * object.
  */
@@ -109,19 +109,28 @@ sdb_data_free_datum(sdb_data_t *datum);
 size_t
 sdb_data_strlen(sdb_data_t *datum);
 
+enum {
+       SDB_UNQUOTED = 0,
+       SDB_SINGLE_QUOTED,
+       SDB_DOUBLE_QUOTED,
+};
+
 /*
  * sdb_data_format:
  * Output the specified datum to the specified string using a default format.
- * If the buffer size is less than the return value of sdb_data_strlen, the
- * datum may be truncated. The buffer will always be nul-terminated after
- * calling this function.
+ * The value of 'quoted' determines whether and how non-integer and
+ * non-decimal values are quoted. If the buffer size is less than the return
+ * value of sdb_data_strlen, the datum may be truncated. The buffer will
+ * always be nul-terminated after calling this function.
  *
  * Returns:
- *  - 0 on success
+ *  - the number of characters written to the buffer (excluding the terminated
+ *    null byte) or the number of characters which would have been written in
+ *    case the output was truncated
  *  - a negative value else
  */
 int
-sdb_data_format(sdb_data_t *datum, char *buf, size_t buflen);
+sdb_data_format(sdb_data_t *datum, char *buf, size_t buflen, int quoted);
 
 #ifdef __cplusplus
 } /* extern "C" */