[Tcladdressbook-commits] Help TclAddressBookHelp.aida,1.4,1.5

[<bde...@us...>]

Update of /cvsroot/tcladdressbook/Help
In directory sc8-pr-cvs1:/tmp/cvs-serv1078/Help

Modified Files:
	TclAddressBookHelp.aida 
Log Message:
Updated syntax for [getme] and [record]

Index: TclAddressBookHelp.aida
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.aida,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- TclAddressBookHelp.aida	13 Dec 2003 17:28:55 -0000	1.4
+++ TclAddressBookHelp.aida	16 Dec 2003 07:37:54 -0000	1.5
@@ -5,7 +5,7 @@
 !! :Author:		Bernard Desgraupes <bde...@ea...>
 !! :Homepage:		<http://webperso.easyconnect.fr/bdesgraupes/>
 !! :Created: 		2003-11-26 14:30:03
-:Modified:	 	2003-12-11 08:18:03
+:Modified:	 	2003-12-13 18:24:43
 !! :Keywords:		Address book, data base
 
 
@@ -65,10 +65,9 @@
 a VCard. The result should be considered as binary data since it can
 contain an image associated to the record.
 
-((s3 addressbook getme ((i varname i))
-This command retrieves all the data available in the database concerning
-the logged-in user ("Me") and stores it in the variable specified by
-the ((i varname i)) argument. The value of this variable takes the form of 
+((s3 addressbook getme
+This command returns all the data available in the database concerning
+the logged-in user ("Me"). The returned value takes the form of 
 a keyed list: see the ((b addressbook record b)) command for a description 
 of this format. Keyed lists can be very easily manipulated with the 
 ((b keylget b)) and ((b keylset b)) commands defined in the TclX extension.
@@ -133,14 +132,11 @@
 ((i propName i)) argument. One can get the list of all the existing
 properties with the ((b addressbook property names b)) command.
 
-((s3 addressbook record ((i recordID varname i))
-This command retrieves all the data available in the database concerning
-the record with unique ID ((i recordID i)) and stores it in the variable
-specified by the ((i varname i)) argument.  The value of this variable
+((s3 addressbook record ((i recordID i))
+This command returns all the data available in the database concerning
+the record with unique ID ((i recordID i)).  The returned value
 takes the form of a keyed list: see the ((b addressbook record b)) command
-for a description of this format. Keyed lists can be very easily manipulated 
-with the ((b keylget b)) and ((b keylset b)) commands defined in the TclX 
-extension. One can also use the usual Tcl commands concerning lists.
+for a description of this format.
 ((nl The format used for a particular value depends on the type of
 the property (string, integer, date, multivalue etc.). Some properties have
 a multiple type: MultiString for fields like Email, Phone etc., MultiDate
@@ -165,6 +161,9 @@
 ((nl Dates are returned as values suitable for use with the ((b clock
 format b)) Tcl command. It is the number of seconds relative to "Thu Jan 01
 00:00:00 CET 1970".
+((nl Note that keyed lists can be very easily manipulated 
+with the ((b keylget b)) and ((b keylset b)) commands defined in the TclX 
+extension. One can also use the usual Tcl commands concerning lists.
 
 ((s3 addressbook save
 This command lets you save the changes made in the database. Commands such