wiki:Documentation/ARexxAPI/ADDRFIND

Version 8 (modified by Jens Maus, 3 years ago) (diff)

--

Languages:

ARexx Function List

  1. Documentation/ARexxAPI/ADDRDELETE
  2. Documentation/ARexxAPI/ADDREDIT
  3. Documentation/ARexxAPI/ADDRFIND
  4. Documentation/ARexxAPI/ADDRGOTO
  5. Documentation/ARexxAPI/ADDRINFO
  6. Documentation/ARexxAPI/ADDRLOAD
  7. Documentation/ARexxAPI/ADDRNEW
  8. Documentation/ARexxAPI/ADDRRESOLVE
  9. Documentation/ARexxAPI/ADDRSAVE
  10. Documentation/ARexxAPI/APPBUSY
  11. Documentation/ARexxAPI/APPNOBUSY
  12. Documentation/ARexxAPI/FINDMAIL
  13. Documentation/ARexxAPI/FLUSHINDEXES
  14. Documentation/ARexxAPI/FOLDERINFO
  15. Documentation/ARexxAPI/GETCONFIGINFO
  16. Documentation/ARexxAPI/GETFOLDERINFO
  17. Documentation/ARexxAPI/GETMAILINFO
  18. Documentation/ARexxAPI/GETSELECTED
  19. Documentation/ARexxAPI/GETURL
  20. Documentation/ARexxAPI/HELP
  21. Documentation/ARexxAPI/HIDE
  22. Documentation/ARexxAPI/INFO
  23. Documentation/ARexxAPI/ISONLINE
  24. Documentation/ARexxAPI/LISTFREEZE
  25. Documentation/ARexxAPI/LISTSELECT
  26. Documentation/ARexxAPI/LISTUNFREEZE
  27. Documentation/ARexxAPI/MAILARCHIVE
  28. Documentation/ARexxAPI/MAILBOUNCE
  29. Documentation/ARexxAPI/MAILCHANGESUBJECT
  30. Documentation/ARexxAPI/MAILCHECK
  31. Documentation/ARexxAPI/MAILCOPY
  32. Documentation/ARexxAPI/MAILDELETE
  33. Documentation/ARexxAPI/MAILEDIT
  34. Documentation/ARexxAPI/MAILEXPORT
  35. Documentation/ARexxAPI/MAILFILTER
  36. Documentation/ARexxAPI/MAILFORWARD
  37. Documentation/ARexxAPI/MAILIMPORT
  38. Documentation/ARexxAPI/MAILINFO
  39. Documentation/ARexxAPI/MAILMOVE
  40. Documentation/ARexxAPI/MAILREAD
  41. Documentation/ARexxAPI/MAILREPLY
  42. Documentation/ARexxAPI/MAILSEND
  43. Documentation/ARexxAPI/MAILSENDALL
  44. Documentation/ARexxAPI/MAILSTATUS
  45. Documentation/ARexxAPI/MAILUPDATE
  46. Documentation/ARexxAPI/MAILWRITE
  47. Documentation/ARexxAPI/NEWMAILFILE
  48. Documentation/ARexxAPI/QUIT
  49. Documentation/ARexxAPI/READCLOSE
  50. Documentation/ARexxAPI/READINFO
  51. Documentation/ARexxAPI/READPRINT
  52. Documentation/ARexxAPI/READSAVE
  53. Documentation/ARexxAPI/REQUEST
  54. Documentation/ARexxAPI/REQUESTFILE
  55. Documentation/ARexxAPI/REQUESTFOLDER
  56. Documentation/ARexxAPI/REQUESTSTRING
  57. Documentation/ARexxAPI/RESTART
  58. Documentation/ARexxAPI/SCREENTOBACK
  59. Documentation/ARexxAPI/SCREENTOFRONT
  60. Documentation/ARexxAPI/SETFLAG
  61. Documentation/ARexxAPI/SETFOLDER
  62. Documentation/ARexxAPI/SETMAIL
  63. Documentation/ARexxAPI/SETMAILFILE
  64. Documentation/ARexxAPI/SHOW
  65. Documentation/ARexxAPI/USERINFO
  66. Documentation/ARexxAPI/WRITEATTACH
  67. Documentation/ARexxAPI/WRITEBCC
  68. Documentation/ARexxAPI/WRITECC
  69. Documentation/ARexxAPI/WRITEEDITOR
  70. Documentation/ARexxAPI/WRITEFROM
  71. Documentation/ARexxAPI/WRITEIDENTITY
  72. Documentation/ARexxAPI/WRITELETTER
  73. Documentation/ARexxAPI/WRITEMAILTO
  74. Documentation/ARexxAPI/WRITEOPTIONS
  75. Documentation/ARexxAPI/WRITEQUEUE
  76. Documentation/ARexxAPI/WRITEREPLYTO
  77. Documentation/ARexxAPI/WRITESEND
  78. Documentation/ARexxAPI/WRITESUBJECT
  79. Documentation/ARexxAPI/WRITETO

ADDRFIND

NAME
AddrFind -- Find one or more entries in the address book. (V2.0)
TEMPLATE
VAR/K,STEM/K,PATTERN/A,NAMEONLY/S,EMAILONLY/S
FUNCTION
Finds one or more entries in the address book, searching by default in the "Alias", "Real name", "E-mail address", "Description", "Street", "City" and "Country" fields.
INPUTS
VAR/K- variable to store the results of the query
STEM/K- base name used for the stems where the aliases for the address book entries matching the query will be stored
PATTERN/A - pattern used as search criterion; all the AmigaDOS wildcard characters are supported
NAMEONLY/S- restrict the search to the "Real name" field of the entries in the address book
EMAILONLY/S- restrict the search to the "E-mail address" field of the entries in the address book
RETURNS
VAR - string containing the number of entries matching the query and a space separated list of the matching aliases.
<stem>ALIAS.COUNT - number of matches found
<stem>ALIAS.NR- the nth alias in the list of aliases matching the query, nr being a number between 0 and n-1.

RC is set to 5 if no match is found.

NOTES
Aliases are returned in the order they appear in the address book.
EXAMPLE
/* Enable result codes */
OPTIONS RESULTS

/* Find all the entries using a given provider */
ADDRFIND PATTERN '#?@saug.org' STEM st. EMAILONLY

/* List results */
IF RC = 0 THEN
   DO i = 0 TO st.alias.count-1
      SAY 'Match #'i+1': 'st.alias.i
   END
ELSE
   SAY 'No matches found.'
EXIT
BUGS
AddrFind can't search into the "Alias" or "Description" fields of groups.
SEE ALSO
ADDRRESOLVE