Update of /cvsroot/tcladdressbook/Help
In directory sc8-pr-cvs1:/tmp/cvs-serv1052/Help
Modified Files:
TclAddressBookHelp
Log Message:
Updated syntax for [getme] and [record]
Index: TclAddressBookHelp
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- TclAddressBookHelp 13 Dec 2003 17:28:49 -0000 1.7
+++ TclAddressBookHelp 16 Dec 2003 07:37:48 -0000 1.8
@@ -1,6 +1,6 @@
Title: Tcladdressbook Help
Project: addressbook extension for Tcl
-Modified: 2003-12-13 18:24:43
+Modified: 2003-12-16 08:35:45
Abstract
@@ -17,7 +17,7 @@
addressbook create (group | person) name ?-ingroup groupID?
addressbook delete recordID ?-fromgroup groupID?
addressbook export personID
- addressbook getme varname
+ addressbook getme
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 varname
+ addressbook record recordID
addressbook save
addressbook search ?(-groups | -persons)? ?-ids? ?-nocase? property op value
addressbook set recordID propertyName ?value?
@@ -93,10 +93,9 @@
a VCard. The result should be considered as binary data since it can
contain an image associated to the record.
- addressbook getme varname
-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 varname argument. The value of this variable takes the form of
+ 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 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.
@@ -161,14 +160,11 @@
propName argument. One can get the list of all the existing
properties with the addressbook property names command.
- 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 variable
-specified by the varname argument. The value of this variable
+ addressbook record recordID
+This command returns all the data available in the database concerning
+the record with unique ID recordID. The returned value
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.
+for a description of this format.
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
@@ -193,6 +189,9 @@
Dates are returned as values suitable for use with the clock
format Tcl command. It is the number of seconds relative to "Thu Jan 01
00:00:00 CET 1970".
+ Note that 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.
addressbook save
This command lets you save the changes made in the database. Commands such
|
