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


Ignore:
Timestamp:
Sep 22, 2013, 10:08:42 PM (15 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/GETSELECTED

    v1 v1  
     1== GETSELECTED
     2
     3'''NAME'''
     4     GetSelected -- Get the position of the messages selected in the current folder.  (V2.0)
     5
     6'''TEMPLATE'''
     7     VAR/K,STEM/K
     8
     9'''FUNCTION'''
     10     Gets the position of the messages selected in the current folder.
     11
     12'''INPUTS'''
     13     VAR/K    - alternative variable to put the results into instead of RESULT\\
     14     STEM/K   - base name used for the stems where the returned data will be stored\\
     15
     16'''RETURNS'''
     17     VAR             - space separated list of results\\
     18     <STEM>NUM.COUNT - number of selected messages\\
     19     <STEM>NUM.NR    - position of the nth selected message, starting from 0; the message at the top of the list is also at position 0\\
     20
     21     The result is just "0" if an empty folder or a folder group
     22     are currently selected.
     23
     24'''NOTES'''
     25
     26'''EXAMPLE'''
     27         /* Enable result codes */
     28
     29         OPTIONS RESULTS
     30
     31         /* Request info */
     32
     33         GETSELECTED STEM st.
     34
     35         /* Display results */
     36
     37         SAY 'Messages selected:  'st.num.count\\
     38         DO i = 0 TO st.num.count-1
     39           SAY 'Position of msg #'i': 'st.num.i
     40         END
     41
     42'''BUGS'''
     43     <STEM>NUM.COUNT was not initialized for empty folders.  This was
     44     fixed in V2.4.
     45
     46'''SEE ALSO'''