Changes between Initial Version and Version 1 of Documentation/ARexxAPI/ADDRDELETE


Ignore:
Timestamp:
Sep 22, 2013, 8:56:05 PM (15 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRDELETE

    v1 v1  
     1== ADDRDELETE
     2
     3'''NAME'''
     4     AddrDelete -- Remove an entry from the address book.  (V2.0)
     5
     6'''TEMPLATE'''
     7     ALIAS
     8
     9'''FUNCTION'''
     10     Removes an entry from the address book.
     11
     12'''INPUTS'''
     13     ALIAS   - Alias of the entry to be removed. 
     14                  This parameter is optional; if it is missing, AddrDelete will remove the current entry, if any.
     15
     16'''RETURNS'''
     17     RC is set to 5 if ALIAS doesn't exist or if none was provided and
     18     there is nothing to delete (because the address book window is
     19     closed).
     20
     21'''NOTES'''
     22     If ALIAS refers to a group or distribution list, all their
     23     contents are deleted as well.
     24
     25     If the address book window is not opened at the time the command
     26     is executed, the deletion cannot be undone.  However, the deletion
     27     doesn't really affect the address book on disk unless the
     28     application is instructed to save the address book with e.g.
     29     [[rx_addrsave| ADDRSAVE ]].
     30
     31'''EXAMPLE'''
     32
     33'''BUGS'''
     34     A missing check for a NULL pointer used to make the command cause
     35     Enforcer hits if no alias was supplied.  This was fixed in V2.4.
     36
     37'''SEE ALSO'''