[Tcladdressbook-commits] Help TclAddressBookHelp,1.6,1.7

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

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

Modified Files:
	TclAddressBookHelp 
Log Message:
Keyed lists

Index: TclAddressBookHelp
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- TclAddressBookHelp	11 Dec 2003 08:46:36 -0000	1.6
+++ TclAddressBookHelp	13 Dec 2003 17:28:49 -0000	1.7
@@ -1,6 +1,6 @@
 Title:			Tcladdressbook Help
 Project:		addressbook extension for Tcl
-Modified:	 	2003-12-08 08:21:01
+Modified:	 	2003-12-13 18:24:43
 
 
 					Abstract
@@ -17,7 +17,7 @@
        addressbook create (group | person) name ?-ingroup groupID?
        addressbook delete recordID ?-fromgroup groupID?
        addressbook export personID
-       addressbook getme arrayvar
+       addressbook getme varname
        addressbook groups ?-ids? ?-ingroup groupID?
        addressbook image personID ?imageData?
        addressbook import vCardData
@@ -26,7 +26,7 @@
        addressbook property names (-groups | -persons)
        addressbook property add (-groups | -persons) propName propType
        addressbook property remove (-groups | -persons) propName
-       addressbook record recordID arrayvar
+       addressbook record recordID varname
        addressbook save
        addressbook search ?(-groups | -persons)? ?-ids? ?-nocase? property op value
        addressbook set recordID propertyName ?value?
@@ -93,11 +93,13 @@
 a VCard. The result should be considered as binary data since it can
 contain an image associated to the record.
 
- addressbook getme arrayvar
+ addressbook getme varname
 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 arrayvar argument. See the addressbook record 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 varname argument. The value of this variable takes the form of 
+a keyed list: see the addressbook record command for a description 
+of this format. Keyed lists can be very easily manipulated with the 
+keylget and keylset commands defined in the TclX extension.
 
  addressbook groups ?-ids? ?-ingroup groupID?
 This command returns a list of all the existing group records: if no option
@@ -159,21 +161,19 @@
 propName argument. One can get the list of all the existing
 properties with the addressbook property names command.
 
- addressbook record recordID arrayvar
+ addressbook record recordID varname
 This command retrieves all the data available in the database concerning
-the record with unique ID recordID and stores it in the array
-variable specified by the arrayvar argument. The keys of the array
-(as returned by the array names 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 arrayvar variable before
-invoking addressbook record in case you use this command repeatedly
-in order to be sure it does not keep stale information.
- The format used to return a particular value depends on the type of
+the record with unique ID recordID and stores it in the variable
+specified by the varname argument.  The value of this variable
+takes the form of a keyed list: see the addressbook record command
+for a description of this format. Keyed lists can be very easily manipulated 
+with the keylget and keylset commands defined in the TclX 
+extension. One can also use the usual Tcl commands concerning lists.
+ 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:
 
 € the elements of a MultiString or MultiDate value list are two-elements