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


Ignore:
Timestamp:
Feb 4, 2014 3:49:14 PM (10 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/ADDRFIND

    v3 v4  
    1 [[TranslatedPages]]\\ 
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]] 
    3  
     1[[TranslatedPages]][[TOC(depth=1)]][[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]] 
    42== ADDRFIND 
    53 
    6 '''NAME''' 
     4 NAME:: 
    75     AddrFind -- Find one or more entries in the address book.  (V2.0) 
    86 
    9 '''TEMPLATE''' 
     7 TEMPLATE:: 
    108     VAR/K,STEM/K,PATTERN/A,NAMEONLY/S,EMAILONLY/S 
    119 
    12 '''FUNCTION''' 
     10 FUNCTION:: 
    1311     Finds one or more entries in the address book, searching by 
    1412     default in the "Alias", "Real name", "E-mail address", 
    1513     "Description", "Street", "City" and "Country" fields. 
    1614 
    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\\ 
     15  INPUTS:: 
     16     `VAR/K`- variable to store the results of the query\\ 
     17     `STEM/K`- base name used for the stems where the aliases for the address book entries matching the query will be stored\\ 
     18     `PATTERN/A` - pattern used as search criterion; all the AmigaDOS wildcard characters are supported\\ 
     19     `NAMEONLY/S`- restrict the search to the "Real name" field of the entries in the address book\\ 
     20     `EMAILONLY/S`- restrict the search to the "E-mail address" field of the entries in the address book\\ 
    2321 
    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.\\ 
     22 RETURNS:: 
     23     `VAR` - string containing the number of entries matching the query and a space separated list of the matching aliases.\\ 
     24     `<stem>ALIAS.COUNT` - number of matches found\\ 
     25     `<stem>ALIAS.NR`- the nth alias in the list of aliases matching the query, nr being a number between 0 and n-1.\\ 
    2826 
    2927     RC is set to 5 if no match is found. 
    3028 
    31 '''NOTES''' 
     29 NOTES:: 
    3230     Aliases are returned in the order they appear in the address book. 
    3331 
    34 '''EXAMPLE''' 
    35          /* Enable result codes */ 
     32 EXAMPLE:: 
     33   {{{#!urbiscript 
     34   /* Enable result codes */ 
     35   OPTIONS RESULTS 
    3636 
    37          OPTIONS RESULTS 
     37   /* Find all the entries using a given provider */ 
     38   ADDRFIND PATTERN '#?@saug.org' STEM st. EMAILONLY 
    3839 
    39          /* Find all the entries using a given provider */ 
     40   /* List results */ 
     41   IF RC = 0 THEN 
     42      DO i = 0 TO st.alias.count-1 
     43         SAY 'Match #'i+1': 'st.alias.i 
     44      END 
     45   ELSE 
     46      SAY 'No matches found.' 
     47   EXIT 
     48   }}} 
    4049 
    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''' 
     50 BUGS:: 
    5451     AddrFind can't search into the "Alias" or "Description" fields of 
    5552     groups. 
    5653 
    57 '''SEE ALSO''' 
    58      [[ARexx API/ADDRRESOLVE| ADDRRESOLVE ]] 
     54 SEE ALSO:: 
     55     [[ADDRRESOLVE]]