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


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/GETFOLDERINFO

    v3 v8  
    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 
     18     - `NUM(BER)`   - position in the folder list (0 = first folder) 
     19     - `NAM(E)`     - name of the folder as shown in the folder list 
     20     - `MAX`        - total number of messages in the folder 
     21     - `PAT(H)`     - folder directory, without path  (V1.3) 
    1922 
    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)\\ 
     23 RETURNS:: 
     24     `VAR`         - info returned by the query\\ 
     25     `<STEM>VALUE` - info returned by the query\\ 
    2426 
    25 '''RETURNS''' 
    26      VAR         - info returned by the query\\ 
    27      <STEM>VALUE - info returned by the query\\ 
     27 NOTES:: 
     28     Superseded by [[FOLDERINFO]] in V2.0+.  Don't use it in new scripts. 
    2829 
    29 '''NOTES''' 
    30      Superseded by [[ARexx API/FOLDERINFO| FOLDERINFO ]] in V2.0+.  Don't use it in new scripts. 
     30 EXAMPLE:: 
     31     {{{#!arexx 
     32     /* Enable result codes */ 
     33     OPTIONS RESULTS 
    3134 
    32 '''EXAMPLE''' 
    33          /* Enable result codes */ 
     35     /* Request 'position' info */ 
     36     GETFOLDERINFO NUMBER VAR position 
     37     IF RC ~= 0 THEN EXIT 
    3438 
    35          OPTIONS RESULTS 
     39     /* Request 'name' info */ 
     40     GETFOLDERINFO NAME VAR name 
     41     IF RC ~= 0 THEN EXIT 
    3642 
    37          /* Request info */ 
     43     /* Request 'max' info */ 
     44     GETFOLDERINFO MAX VAR total 
     45     IF RC ~= 0 THEN EXIT 
    3846 
    39          GETFOLDERINFO NUMBER VAR position\\ 
    40          GETFOLDERINFO NAME VAR name\\ 
    41          GETFOLDERINFO MAX VAR total\\ 
    42          GETFOLDERINFO PATH VAR path\\ 
     47     /* Request 'path' info */ 
     48     GETFOLDERINFO PATH VAR path 
     49     IF RC ~= 0 THEN EXIT 
    4350 
    44          /* Display results */ 
     51     /* Display results */ 
     52     SAY 'Folder name:    'name 
     53     SAY 'Path:           'path 
     54     SAY 'Place in list:  'position 
     55     SAY 'Total messages: 'total 
     56     }}} 
    4557 
    46          SAY 'Folder name:    'name\\ 
    47          SAY 'Path:           'path\\ 
    48          SAY 'Place in list:  'position\\ 
    49          SAY 'Total messages: 'total\\ 
     58 BUGS:: 
    5059 
    51 '''BUGS''' 
    52  
    53 '''SEE ALSO''' 
    54      [[ARexx API/FOLDERINFO| FOLDERINFO ]] 
     60 SEE ALSO:: 
     61     [[FOLDERINFO]]