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


Ignore:
Timestamp:
Feb 4, 2014, 7:14:29 PM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/GETFOLDERINFO

    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== GETFOLDERINFO
    54
    6 '''NAME'''
     5 NAME::
    76     GetFolderInfo -- Return information about the current folder.
    87
    9 '''TEMPLATE'''
     8 TEMPLATE::
    109     VAR/K,STEM/K,ITEM/A
    1110
    12 '''FUNCTION'''
     11 FUNCTION::
    1312     Returns information about the current folder.
    1413
    15 '''INPUTS'''
    16      VAR/K    - alternative variable to put the results into instead of RESULT  (V2.0)\\
    17      STEM/K   - base name used for the stems where the returned data will be stored  (V2.0)\\
    18      ITEM/A   - item to return info about, may be one of
     14 INPUTS::
     15     `VAR/K`    - alternative variable to put the results into instead of RESULT  (V2.0)\\
     16     `STEM/K`   - base name used for the stems where the returned data will be stored  (V2.0)\\
     17     `ITEM/A`   - item to return info about, may be one of
    1918
    20                    NUM(BER)   - position in the folder list (0 = first folder)\\
    21                    NAM(E)     - name of the folder as shown in the folder list\\
    22                    MAX        - total number of messages in the folder\\
    23                    PAT(H)     - folder directory, without path  (V1.3)\\
     19                   `NUM(BER)`   - position in the folder list (0 = first folder)\\
     20                   `NAM(E)`     - name of the folder as shown in the folder list\\
     21                   `MAX`        - total number of messages in the folder\\
     22                   `PAT(H)`     - folder directory, without path  (V1.3)\\
    2423
    25 '''RETURNS'''
    26      VAR         - info returned by the query\\
    27      <STEM>VALUE - info returned by the query\\
     24 RETURNS::
     25     `VAR`         - info returned by the query\\
     26     `<STEM>VALUE` - info returned by the query\\
    2827
    29 '''NOTES'''
    30      Superseded by [[ARexx API/FOLDERINFO| FOLDERINFO ]] in V2.0+.  Don't use it in new scripts.
     28 NOTES::
     29     Superseded by [[FOLDERINFO]] in V2.0+.  Don't use it in new scripts.
    3130
    32 '''EXAMPLE'''
    33          /* Enable result codes */
     31 EXAMPLE::
     32     {{{#!urbiscript
     33     /* Enable result codes */
     34     OPTIONS RESULTS
    3435
    35          OPTIONS RESULTS
     36     /* Request info */
     37     GETFOLDERINFO NUMBER VAR position
     38     GETFOLDERINFO NAME VAR name
     39     GETFOLDERINFO MAX VAR total
     40     GETFOLDERINFO PATH VAR path
    3641
    37          /* Request info */
     42     /* Display results */
     43     SAY 'Folder name:    'name
     44     SAY 'Path:           'path
     45     SAY 'Place in list:  'position
     46     SAY 'Total messages: 'total
     47     }}}
    3848
    39          GETFOLDERINFO NUMBER VAR position\\
    40          GETFOLDERINFO NAME VAR name\\
    41          GETFOLDERINFO MAX VAR total\\
    42          GETFOLDERINFO PATH VAR path\\
     49 BUGS::
    4350
    44          /* Display results */
    45 
    46          SAY 'Folder name:    'name\\
    47          SAY 'Path:           'path\\
    48          SAY 'Place in list:  'position\\
    49          SAY 'Total messages: 'total\\
    50 
    51 '''BUGS'''
    52 
    53 '''SEE ALSO'''
    54      [[ARexx API/FOLDERINFO| FOLDERINFO ]]
     51 SEE ALSO::
     52     [[FOLDERINFO]]