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


Ignore:
Timestamp:
Feb 4, 2014, 9:39:40 PM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/GETSELECTED

    v3 v4  
    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== GETSELECTED
    54
    6 '''NAME'''
     5 NAME::
    76     GetSelected -- Get the position of the messages selected in the current folder.  (V2.0)
    87
    9 '''TEMPLATE'''
     8 TEMPLATE::
    109     VAR/K,STEM/K
    1110
    12 '''FUNCTION'''
     11 FUNCTION::
    1312     Gets the position of the messages selected in the current folder.
    1413
    15 '''INPUTS'''
    16      VAR/K    - alternative variable to put the results into instead of RESULT\\
    17      STEM/K   - base name used for the stems where the returned data will be stored\\
     14 INPUTS::
     15     `VAR/K`    - alternative variable to put the results into instead of RESULT\\
     16     `STEM/K`   - base name used for the stems where the returned data will be stored\\
    1817
    19 '''RETURNS'''
    20      VAR             - space separated list of results\\
    21      <STEM>NUM.COUNT - number of selected messages\\
    22      <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\\
     18 RETURNS::
     19     `VAR`             - space separated list of results\\
     20     `<STEM>NUM.COUNT` - number of selected messages\\
     21     `<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\\
    2322
    2423     The result is just "0" if an empty folder or a folder group
    2524     are currently selected.
    2625
    27 '''NOTES'''
     26 NOTES::
    2827
    29 '''EXAMPLE'''
    30          /* Enable result codes */
     28 EXAMPLE::
     29    {{{#!urbiscript
     30    /* Enable result codes */
     31    OPTIONS RESULTS
    3132
    32          OPTIONS RESULTS
     33    /* Request info */
     34    GETSELECTED STEM st.
    3335
    34          /* Request info */
     36    /* Display results */
     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    }}}
    3542
    36          GETSELECTED STEM st.
    37 
    38          /* Display results */
    39 
    40          SAY 'Messages selected:  'st.num.count\\
    41          DO i = 0 TO st.num.count-1
    42            SAY 'Position of msg #'i': 'st.num.i
    43          END
    44 
    45 '''BUGS'''
    46      <STEM>NUM.COUNT was not initialized for empty folders.  This was
     43 BUGS::
     44     `<STEM>NUM.COUNT` was not initialized for empty folders.  This was
    4745     fixed in V2.4.
    4846
    49 '''SEE ALSO'''
     47 SEE ALSO::