Changes between Version 5 and Version 6 of Documentation/ARexxAPI/ADDRDELETE


Ignore:
Timestamp:
Feb 4, 2014, 2:46:59 PM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRDELETE

    v5 v6  
    1 [[TranslatedPages]]\\
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]]
    3 
     1[[TranslatedPages]][[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]]
    42== ADDRDELETE
    53
    6 '''NAME'''
    7      AddrDelete -- Remove an entry from the address book.  (V2.0)
     4 NAME::
     5  AddrDelete -- Remove an entry from the address book.  (V2.0)
    86
    9 '''TEMPLATE'''
    10      ALIAS
     7 TEMPLATE::
     8  ALIAS
    119
    12 '''FUNCTION'''
    13      Removes an entry from the address book.
     10 FUNCTION::
     11  Removes an entry from the address book.
    1412
    15 '''INPUTS'''
    16      ALIAS   - Alias of the entry to be removed. 
    17                   This parameter is optional; if it is missing, AddrDelete will remove the current entry, if any.
     13 INPUTS::
     14  ALIAS - Alias of the entry to be removed. This parameter is optional; if it is missing, AddrDelete will remove the current entry, if any.
    1815
    19 '''RETURNS'''
    20      RC is set to 5 if ALIAS doesn't exist or if none was provided and
    21      there is nothing to delete (because the address book window is
    22      closed).
     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).
    2320
    24 '''NOTES'''
    25      If ALIAS refers to a group or distribution list, all their
    26      contents are deleted as well.
     21 NOTES::
     22  If ALIAS refers to a group or distribution list, all their
     23  contents are deleted as well.
    2724
    28      If the address book window is not opened at the time the command
    29      is executed, the deletion cannot be undone.  However, the deletion
    30      doesn't really affect the address book on disk unless the
    31      application is instructed to save the address book with e.g.
    32      [[ARexx API/ADDRSAVE| ADDRSAVE ]].
     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  [[ADDRSAVE]].
    3330
    34 '''EXAMPLE'''
     31 EXAMPLE::
    3532
    36 '''BUGS'''
    37      A missing check for a NULL pointer used to make the command cause
    38      Enforcer hits if no alias was supplied.  This was fixed in V2.4.
     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.
    3936
    40 '''SEE ALSO'''
     37 SEE ALSO::