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


Ignore:
Timestamp:
Sep 22, 2013 9:33:30 PM (14 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRNEW

    v1 v1  
     1== ADDRNEW 
     2 
     3'''NAME''' 
     4     AddrNew -- Create a new entry in the address book.  (V2.0) 
     5 
     6'''TEMPLATE''' 
     7     VAR/K,STEM/K,TYPE,ALIAS,NAME,EMAIL 
     8 
     9'''FUNCTION''' 
     10     Creates a new entry in the address book and inserts it below 
     11     the last active entry.  If the address book window has not yet 
     12     been opened in the current session, the new entry will be added 
     13     below the first entry. 
     14 
     15'''INPUTS''' 
     16     VAR/K    - variable where the alias of the resulting entry will be stored\\ 
     17     STEM/K   - base name used for the stem where the alias of the resulting entry will be stored\\ 
     18     TYPE     - type of entry, may be one of G (group), L (distribution list) or P (person, the default value)\\ 
     19     ALIAS    - alias for the new entry\\ 
     20     NAME     - real name for the new entry\\ 
     21     EMAIL    - email address for the new entry\\ 
     22 
     23'''RETURNS''' 
     24     VAR         - alias of the resulting entry\\ 
     25     <STEM>ALIAS - alias of the resulting entry\\ 
     26 
     27'''NOTES''' 
     28     At least one of ALIAS, NAME or EMAIL should be specified.  Bogus 
     29     types are simply ignored. 
     30 
     31     If the provided alias exists already, a new alias will be used 
     32     instead by taking the supplied string and adding a trailing 
     33     number until no clash is produced.  String limits are also taken 
     34     into account. 
     35 
     36     If no alias is provided, one will be created automatically by 
     37     using a cut-down version of the NAME or EMAIL arguments; for 
     38     instance, "Jose Luis Feliciano" would turn into "J_Feliciano", 
     39     or "Jose" if Jose@example.com was the only argument provided. 
     40     The rule mentioned above is also applied. 
     41 
     42     If the address book window is closed at the time the new entry 
     43     is added, it won't count as a change in the address book, which 
     44     means you won't be warned if you try to quit YAM afterwards 
     45     without saving the address book. 
     46 
     47     While using spaces in aliases is possible, it is discouraged. 
     48 
     49'''EXAMPLE''' 
     50         /* Create a new group */ 
     51 
     52         ADDRNEW G 'Singers' 
     53 
     54         /* Create a new distribution list */ 
     55 
     56         ADDRNEW L 'Spanish' 
     57 
     58'''BUGS''' 
     59 
     60'''SEE ALSO''' 
     61     [[rx_addredit| ADDREDIT ]]