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


Ignore:
Timestamp:
Sep 22, 2013, 9:09:54 PM (15 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRFIND

    v1 v1  
     1== ADDRFIND
     2
     3'''NAME'''
     4     AddrFind -- Find one or more entries in the address book.  (V2.0)
     5
     6'''TEMPLATE'''
     7     VAR/K,STEM/K,PATTERN/A,NAMEONLY/S,EMAILONLY/S
     8
     9'''FUNCTION'''
     10     Finds one or more entries in the address book, searching by
     11     default in the "Alias", "Real name", "E-mail address",
     12     "Description", "Street", "City" and "Country" fields.
     13
     14'''INPUTS'''
     15     VAR/K         - variable to store the results of the query\\
     16     STEM/K        - base name used for the stems where the aliases for the address book entries matching the query will be stored\\
     17     PATTERN/A     - pattern used as search criterion; all the AmigaDOS wildcard characters are supported\\
     18     NAMEONLY/S    - restrict the search to the "Real name" field of the entries in the address book\\
     19     EMAILONLY/S   - restrict the search to the "E-mail address" field of the entries in the address book\\
     20
     21'''RETURNS'''
     22     VAR               - string containing the number of entries matching the query and a space separated list of the matching aliases.\\
     23     <stem>ALIAS.COUNT - number of matches found\\
     24     <stem>ALIAS.NR    - the nth alias in the list of aliases matching the query, nr being a number between 0 and n-1.\\
     25
     26     RC is set to 5 if no match is found.
     27
     28'''NOTES'''
     29     Aliases are returned in the order they appear in the address book.
     30
     31'''EXAMPLE'''
     32         /* Enable result codes */
     33
     34         OPTIONS RESULTS
     35
     36         /* Find all the entries using a given provider */
     37
     38         ADDRFIND PATTERN '#?@saug.org' STEM st. EMAILONLY
     39
     40         /* List results */
     41
     42         IF RC = 0 THEN
     43            DO i = 0 TO st.alias.count-1
     44               SAY 'Match #'i+1': 'st.alias.i
     45            END
     46         ELSE
     47            SAY 'No matches found.'
     48         EXIT
     49
     50'''BUGS'''
     51     AddrFind can't search into the "Alias" or "Description" fields of
     52     groups.
     53
     54'''SEE ALSO'''
     55     [[rx_addrresolve| ADDRRESOLVE ]]