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

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

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

Modified Files:
	TclAddressBookHelp.aida 
Log Message:
Keyed lists

Index: TclAddressBookHelp.aida
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.aida,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- TclAddressBookHelp.aida	11 Dec 2003 08:43:49 -0000	1.3
+++ TclAddressBookHelp.aida	13 Dec 2003 17:28:55 -0000	1.4
@@ -65,11 +65,13 @@
 a VCard. The result should be considered as binary data since it can
 contain an image associated to the record.
 
-((s3 addressbook getme ((i arrayvar i))
+((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 array variable specified by
-the ((i arrayvar i)) argument. See the ((b addressbook record b)) command
-for a description of the format of the various kinds of properties.
+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 
+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.
 
 ((s3 addressbook groups ?-ids? ?-ingroup ((i groupID i))?
 This command returns a list of all the existing group records: if no option
@@ -131,21 +133,19 @@
 ((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 arrayvar i))
+((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 array
-variable specified by the ((i arrayvar i)) argument. The keys of the array
-(as returned by the ((b array names b)) Tcl command) are the names of the
-properties: the values are the current values of the corresponding
-property. Only existing properties for the specified record are returned by
-this command: you should unset the ((i arrayvar i)) variable before
-invoking ((b addressbook record b)) in case you use this command repeatedly
-in order to be sure it does not keep stale information.
-((nl The format used to return a particular value depends on the type of
+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
+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.
+((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
 for fields like ABDate, MultiDictionary for the Address field. In case of a
-multivalue, the returned value is a Tcl list. Each element of the list
+multivalue, the returned value is a keyed list itself. Each element of the list
 corresponds to a single property. For instance:
 ((lu
 ((li the elements of a MultiString or MultiDate value list are two-elements