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