[Tcladdressbook-commits] Help TclAddressBookHelp.aida,1.2,1.3
Status: Alpha
Brought to you by:
bdesgraupes
|
From: <bde...@us...> - 2003-12-11 08:43:52
|
Update of /cvsroot/tcladdressbook/Help In directory sc8-pr-cvs1:/tmp/cvs-serv14896/Help Modified Files: TclAddressBookHelp.aida Log Message: Doc [delete] Index: TclAddressBookHelp.aida =================================================================== RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.aida,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- TclAddressBookHelp.aida 11 Dec 2003 06:53:43 -0000 1.2 +++ TclAddressBookHelp.aida 11 Dec 2003 08:43:49 -0000 1.3 @@ -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-08 08:21:01 +:Modified: 2003-12-11 08:18:03 !! :Keywords: Address book, data base @@ -37,11 +37,11 @@ ((s3 addressbook changed This command returns 1 if there has been changes made to the database, 0 otherwise. Changes are made in memory with commands such as ((b addressbook -set b)), ((b addressbook create b)), ((b addressbook remove b)). To make +set b)), ((b addressbook create b)), ((b addressbook delete b)). To make these changes permanent, one must call the ((b addressbook save b)) command. -((s3 addressbook count (-groups | -persons) ?-ingroup groupID? +((s3 addressbook count (-groups | -persons) ?-ingroup ((i groupID i))? This command returns the count of existing groups or persons in the database. One can specify a particular group with the -ingroup option to count only the subgroups or members in this group. @@ -54,6 +54,12 @@ particular group with unique ID ((i groupID i)). If no error occurs, the command returns the unique ID of the created record. +((s3 addressbook delete ((i recordID i)) ?-fromgroup ((i groupID i))? +This command removes the record with unique ID ((i recordID i)) from the +database or from a particular subgroup specified by its unique ID with the +((i -fromgroup i)) option. Note that any changes made to the database won't +be definitive until you invoke the ((b addressbook save b)) command. + ((s3 addressbook export ((i personID i)) This command lets you export the record with unique ID ((i personID i)) as a VCard. The result should be considered as binary data since it can @@ -160,16 +166,10 @@ format b)) Tcl command. It is the number of seconds relative to "Thu Jan 01 00:00:00 CET 1970". -((s3 addressbook remove ((i recordID i)) ?-fromgroup ((i groupID i))? -This command removes the record with unique ID ((i recordID i)) from the -database or from a particular subgroup specified by its unique ID with the -((i -fromgroup i)) option. Note that any changes made to the database won't -be definitive until you invoke the ((b addressbook save b)) command. - ((s3 addressbook save This command lets you save the changes made in the database. Commands such as ((b addressbook set b)), ((b addressbook create b)) or ((b addressbook -remove b)) modify the data in memory: to make the changes definitive in the +delete b)) modify the data in memory: to make the changes definitive in the database, one must call explicitely the ((b addressbook save b)) command. To check whether there has been changes in the database, use the ((b addressbook changed b)) command. @@ -223,10 +223,6 @@ name. The ((i -nocase i)) argument concerns string comparisons and requires that no distinction be made between uppercase and lowercase letters. -((s3 addressbook type ((i recordID i)) -This command returns the type (ABPerson or ABGroup) of the record with -unique ID ((i recordID i)). - ((s3 addressbook set ((i recordID propertyName i)) ?((i value i))? This command lets you get or set the value of a particular property for the record with unique ID ((i recordID i)). If the ((i value i)) argument is @@ -235,6 +231,10 @@ property ((i propertyName i)) will be set to this value. See the ((b addressbook record b)) command for a description of the format used for the various kinds of properties. + +((s3 addressbook type ((i recordID i)) +This command returns the type (ABPerson or ABGroup) of the record with +unique ID ((i recordID i)). ((s1 INSTALLATION |