Changes between Version 3 and Version 9 of Documentation/ARexxAPI/ADDRINFO


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRINFO

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