[Tcladdressbook-commits] Help TclAddressBookHelp.html,1.6,1.7

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

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

Modified Files:
	TclAddressBookHelp.html 
Log Message:
Keyed lists

Index: TclAddressBookHelp.html
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- TclAddressBookHelp.html	11 Dec 2003 08:46:42 -0000	1.6
+++ TclAddressBookHelp.html	13 Dec 2003 17:29:01 -0000	1.7
@@ -28,7 +28,7 @@
 <UL><UL><LI><A HREF="#M7">addressbook create (group | person) <I>name</I> ?-ingroup <I>groupID</I>?</A></UL></UL>
 <UL><UL><LI><A HREF="#M8">addressbook delete <I>recordID</I> ?-fromgroup <I>groupID</I>?</A></UL></UL>
 <UL><UL><LI><A HREF="#M9">addressbook export <I>personID</I></A></UL></UL>
-<UL><UL><LI><A HREF="#M10">addressbook getme <I>arrayvar</I></A></UL></UL>
+<UL><UL><LI><A HREF="#M10">addressbook getme <I>varname</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M11">addressbook groups ?-ids? ?-ingroup <I>groupID</I>?</A></UL></UL>
 <UL><UL><LI><A HREF="#M12">addressbook image <I>personID</I> ?<I>imageData</I>?</A></UL></UL>
 <UL><UL><LI><A HREF="#M13">addressbook import <I>vCardData</I></A></UL></UL>
@@ -37,7 +37,7 @@
 <UL><UL><LI><A HREF="#M16">addressbook property names (-groups | -persons)</A></UL></UL>
 <UL><UL><LI><A HREF="#M17">addressbook property add (-groups | -persons) <I>propName</I> <I>propType</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M18">addressbook property remove (-groups | -persons) <I>propName</I></A></UL></UL>
-<UL><UL><LI><A HREF="#M19">addressbook record <I>recordID arrayvar</I></A></UL></UL>
+<UL><UL><LI><A HREF="#M19">addressbook record <I>recordID varname</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M20">addressbook save</A></UL></UL>
 <UL><UL><LI><A HREF="#M21">addressbook search ?(-groups | -persons)? ?-ids? ?-nocase? <I>property op value</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M22">addressbook set <I>recordID propertyName</I> ?<I>value</I>?</A></UL></UL>
@@ -103,11 +103,13 @@
 a VCard. The result should be considered as binary data since it can
 contain an image associated to the record.
 
-<H4><A NAME="M10"></A> addressbook getme <I>arrayvar</I></H4>
+<H4><A NAME="M10"></A> addressbook getme <I>varname</I></H4>
 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.
 
 <H4><A NAME="M11"></A> addressbook groups ?-ids? ?-ingroup <I>groupID</I>?</H4>
 This command returns a list of all the existing group records: if no option
@@ -169,21 +171,19 @@
 <I>propName</I> argument. One can get the list of all the existing
 properties with the <B>addressbook property names</B> command.
 
-<H4><A NAME="M19"></A> addressbook record <I>recordID arrayvar</I></H4>
+<H4><A NAME="M19"></A> addressbook record <I>recordID varname</I></H4>
 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.
-<P> 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.
+<P> 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:
 <UL>
 	<LI> the elements of a MultiString or MultiDate value list are two-elements