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


Ignore:
Timestamp:
Sep 22, 2013 9:18:37 PM (12 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRINFO

    v1 v1  
     1== ADDRINFO 
     2 
     3'''NAME''' 
     4     AddrInfo -- Return information about an address book entry.  (V2.0) 
     5 
     6'''TEMPLATE''' 
     7     VAR/K,STEM/K,ALIAS/A 
     8 
     9'''FUNCTION''' 
     10    Returns information about an address book entry. 
     11 
     12'''INPUTS''' 
     13     VAR/K     - variable to store the results of the query\\ 
     14     STEM/K    - base name used for the stems where the returned data will be stored\\ 
     15     ALIAS/A   - alias of the entry to return info about\\ 
     16 
     17'''RETURNS''' 
     18     <STEM>TYPE          - type of entry, may be one of P (person), L (distribution list) or G (group)\\ 
     19     <STEM>NAME          - real name of this entry\\ 
     20     <STEM>EMAIL         - email address of this entry\\ 
     21     <STEM>PGP           - PGP key ID of this entry\\ 
     22     <STEM>HOMEPAGE      - homepage of this entry\\ 
     23     <STEM>STREET        - street address of this entry\\ 
     24     <STEM>CITY          - city for this entry\\ 
     25     <STEM>COUNTRY       - country for this entry\\ 
     26     <STEM>PHONE         - phone # of this entry\\ 
     27     <STEM>COMMENT       - comment stored with this entry\\ 
     28     <STEM>BIRTHDATE     - date of birth of this entry, in (D)DMMYYYY format\\ 
     29     <STEM>IMAGE         - filename with the portrait picture of this entry\\ 
     30     <STEM>MEMBERS.COUNT - number of members, if the entry is actually a distribution list\\ 
     31     <STEM>MEMBERS.NR    - the nth member if the entry is actually a distribution list, NR being a number between 0 and n-1\\ 
     32 
     33     RC is set to 10 if the supplied alias does not exist or none was provided. 
     34 
     35'''NOTES''' 
     36     Fields where information is not available are returned as an 
     37     empty string, except for the birth date which is returned as 
     38     a literal zero (0). 
     39 
     40'''EXAMPLE''' 
     41         /* Enable result codes */ 
     42 
     43         OPTIONS RESULTS 
     44 
     45         /* Ignore possible error from ADDRINFO */ 
     46 
     47         OPTIONS FAILAT 11 
     48 
     49         /* Find a given entry */ 
     50 
     51         ADDRINFO 'mars' STEM st. 
     52 
     53         /* List results */ 
     54 
     55         IF RC ~= 0 THEN EXIT 
     56 
     57         SAY 'Type of entry: 'st.type\\ 
     58         SAY 'Real name:     'st.name\\ 
     59         SAY 'Email address: 'st.email\\ 
     60         SAY 'PGP key ID:    'st.pgp\\ 
     61         SAY 'Homepage:      'st.homepage\\ 
     62         SAY 'Street:        'st.street\\ 
     63         SAY 'City:          'st.city\\ 
     64         SAY 'Country:       'st.country\\ 
     65         SAY 'Phone #:       'st.phone\\ 
     66         SAY 'Description:   'st.comment\\ 
     67         SAY 'Date of birth: 'st.birthdate\\ 
     68         SAY 'Portrait:      'st.image\\ 
     69 
     70'''BUGS''' 
     71 
     72'''SEE ALSO'''