From ae72fcc7930fb4dcb554dac037610d5905b7b418 Mon Sep 17 00:00:00 2001 From: Peter Verthez Date: Mon, 30 Dec 2002 09:34:12 +0000 Subject: [PATCH] Documentation for new function to update timestamp. --- doc/gom.html | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/doc/gom.html b/doc/gom.html index 7358ad1..4ab405a 100644 --- a/doc/gom.html +++ b/doc/gom.html @@ -126,7 +126,12 @@ tags is.  Each element of the linked list has:
This way, none of the information in the GEDCOM file is lost, even the non-standard information.

-

Modifying the object model

+

Modifying the object model

Currently, there are only functions available to modify strings in the model (and the date manipulation functions described here). + In principle it is possible to add new records, notes, ... yourself, +but you have to know what you are doing, because you should keep the model +consistent.  In the next release, functions will be available to add, +remove and modify anything in the model.
+

Manipulating strings

There are some functions available to retrieve and change strings in the @@ -175,9 +180,16 @@ the current locale); in that case the target data variable is not modified.
Writing the current object model to a file is simply done using the following function:
int gom_write_file (const char* filename, int* total_conv_fails);
-This writes the model to the file filename.  The second parameter can return the total number of conversion failures (pass NULL if you're not interested).
-
-The functions in this section can be used before gom_write_file to control some settings.
+This writes the model to the file filename.  The second parameter can return the total number of conversion failures (pass NULL if you're not interested).  The functions in this section can be used before gom_write_file to control some settings.
+
+Before you write the file, you can update the timestamp in the header using the following function:
+
int gom_header_update_timestamp (time_t tval);
+This sets the date and time fields of the header to the time indicated by tval. + The function returns 0 on success, non-zero if an error occurred.  Typically, +the function would be used as follows, to set the current time in the timestamp:
+
int result;
+result = gom_header_update_timestamp(time(NULL));
+

$Id$
$Name$
@@ -195,4 +207,5 @@ The functions in this section


+
\ No newline at end of file -- 2.30.2