Changes between Version 3 and Version 8 of Documentation/ARexxAPI/ADDRFIND


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

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRFIND

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