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


Ignore:
Timestamp:
Feb 4, 2014, 4:32:16 PM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRINFO

    v3 v4  
    1 [[TranslatedPages]]\\
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]]
    3 
     1[[TranslatedPages]][[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]]
    42== ADDRINFO
    53
    6 '''NAME'''
     4 NAME::
    75     AddrInfo -- Return information about an address book entry.  (V2.0)
    86
    9 '''TEMPLATE'''
     7 TEMPLATE::
    108     VAR/K,STEM/K,ALIAS/A
    119
    12 '''FUNCTION'''
     10 FUNCTION::
    1311    Returns information about an address book entry.
    1412
    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\\
     13 INPUTS::
     14     `VAR/K`     - variable to store the results of the query\\
     15     `STEM/K`    - base name used for the stems where the returned data will be stored\\
     16     `ALIAS/A`   - alias of the entry to return info about\\
    1917
    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\\
     18 RETURNS::
     19     `<STEM>TYPE`          - type of entry, may be one of P (person), L (distribution list) or G (group)\\
     20     `<STEM>NAME`          - real name of this entry\\
     21     `<STEM>EMAIL`         - email address of this entry\\
     22     `<STEM>PGP`           - PGP key ID of this entry\\
     23     `<STEM>HOMEPAGE`      - homepage of this entry\\
     24     `<STEM>STREET`        - street address of this entry\\
     25     `<STEM>CITY`          - city for this entry\\
     26     `<STEM>COUNTRY`       - country for this entry\\
     27     `<STEM>PHONE`         - phone # of this entry\\
     28     `<STEM>COMMENT`       - comment stored with this entry\\
     29     `<STEM>BIRTHDATE`     - date of birth of this entry, in (D)DMMYYYY format\\
     30     `<STEM>IMAGE`         - filename with the portrait picture of this entry\\
     31     `<STEM>MEMBERS.COUNT` - number of members, if the entry is actually a distribution list\\
     32     `<STEM>MEMBERS.NR`    - the nth member if the entry is actually a distribution list, NR being a number between 0 and n-1\\
    3533
    36      RC is set to 10 if the supplied alias does not exist or none was provided.
     34     `RC` is set to 10 if the supplied alias does not exist or none was provided.
    3735
    38 '''NOTES'''
     36 NOTES::
    3937     Fields where information is not available are returned as an
    4038     empty string, except for the birth date which is returned as
    4139     a literal zero (0).
    4240
    43 '''EXAMPLE'''
     41 EXAMPLE::
     42{{{#!urbiscript
     43
    4444         /* Enable result codes */
    45 
    4645         OPTIONS RESULTS
    4746
    4847         /* Ignore possible error from ADDRINFO */
    49 
    5048         OPTIONS FAILAT 11
    5149
    5250         /* Find a given entry */
    53 
    5451         ADDRINFO 'mars' STEM st.
    5552
    5653         /* List results */
    57 
    5854         IF RC ~= 0 THEN EXIT
    5955
    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\\
     56         SAY 'Type of entry: 'st.type
     57         SAY 'Real name:     'st.name
     58         SAY 'Email address: 'st.email
     59         SAY 'PGP key ID:    'st.pgp
     60         SAY 'Homepage:      'st.homepage
     61         SAY 'Street:        'st.street
     62         SAY 'City:          'st.city
     63         SAY 'Country:       'st.country
     64         SAY 'Phone #:       'st.phone
     65         SAY 'Description:   'st.comment
     66         SAY 'Date of birth: 'st.birthdate
     67         SAY 'Portrait:      'st.image
     68}}}
    7269
    73 '''BUGS'''
     70 BUGS::
    7471
    75 '''SEE ALSO'''
     72 SEE ALSO::