Documentation ARexxAPI ADDRDELETE

ADDRDELETE

NAME:: AddrDelete -- Remove an entry from the address book. (V2.0)

TEMPLATE:: ALIAS

FUNCTION:: Removes an entry from the address book.

INPUTS:: ALIAS - Alias of the entry to be removed. This parameter is optional; if it is missing, AddrDelete will remove the current entry, if any.

RETURNS:: RC is set to 5 if ALIAS doesn't exist or if none was provided and there is nothing to delete (because the address book window is closed).

NOTES:: If ALIAS refers to a group or distribution list, all their contents are deleted as well.

If the address book window is not opened at the time the command is executed, the deletion cannot be undone. However, the deletion doesn't really affect the address book on disk unless the application is instructed to save the address book with e.g. ADDRSAVE.

EXAMPLE::

BUGS:: A missing check for a NULL pointer used to make the command cause Enforcer hits if no alias was supplied. This was fixed in V2.4.

SEE ALSO::