Changes between Version 3 and Version 7 of Documentation/ARexxAPI/FOLDERINFO


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

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/FOLDERINFO

    v3 v7  
    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== FOLDERINFO
    54
    6 '''NAME'''
     5 NAME::
    76     FolderInfo -- Return information about a folder.  (V2.0)
    87
    9 '''TEMPLATE'''
     8 TEMPLATE::
    109     VAR/K,STEM/K,FOLDER
    1110
    12 '''FUNCTION'''
     11 FUNCTION::
    1312     Returns information about the specified folder, or the current
    1413     folder if none is specified.
    1514
    16 '''INPUTS'''
    17      VAR/K    - variable where the results will be stored\\
    18      STEM/K   - base name used for the stems where the returned data will be stored\\
    19      FOLDER   - name or path of the folder we want to get info about; if no folder is specified, the current folder will be used  (V2.2)\\
     15 INPUTS::
     16     `VAR/K`    - variable where the results will be stored\\
     17     `STEM/K`   - base name used for the stems where the returned data will be stored\\
     18     `FOLDER`   - name or path of the folder we want to get info about; if no folder is specified, the current folder will be used  (V2.2)\\
    2019
    21 '''RETURNS'''
    22      VAR          - string with a space separated list of the results of the query\\
    23      <STEM>NUMBER - position of the folder in the folder list; the folder at the top is in slot 0\\
    24      <STEM>NAME   - name of the folder as shown in the folder list\\
    25      <STEM>PATH   - path of the folder, e.g. "incoming"\\
    26      <STEM>TOTAL  - total number of messages in the folder\\
    27      <STEM>NEW    - number of new messages in the folder\\
    28      <STEM>UNREAD - number of unread messages in the folder\\
    29      <STEM>SIZE   - size of the folder, in bytes\\
    30      <STEM>TYPE   - type of folder (V2.3), possible values are:
     20 RETURNS::
     21     `VAR`          - string with a space separated list of the results of the query\\
     22     `<STEM>NUMBER` - position of the folder in the folder list; the folder at the top is in slot 0\\
     23     `<STEM>NAME`   - name of the folder as shown in the folder list\\
     24     `<STEM>PAT`   - path of the folder, e.g. "incoming"\\
     25     `<STEM>TOTAL`  - total number of messages in the folder\\
     26     `<STEM>NEW`    - number of new messages in the folder\\
     27     `<STEM>UNREAD` - number of unread messages in the folder\\
     28     `<STEM>SIZE`   - size of the folder, in bytes\\
     29     `<STEM>TYPE`   - type of folder (V2.3), possible values are:
     30       - `0` - normal
     31       - `1` - incoming
     32       - `2` - outgoing
     33       - `3` - sent (for the default "Sent" folder)
     34       - `4` - deleted
     35       - `5` - sent and received
     36       - `6` - sent
    3137
    32                        0 - normal\\
    33                        1 - incoming\\
    34                        2 - outgoing\\
    35                        3 - sent (for the default "Sent" folder)\\
    36                        4 - deleted\\
    37                        5 - sent and received\\
    38                        6 - sent\\
     38     `RC` is set to 10 if the specified folder cannot be found.
    3939
    40      RC is set to 10 if the specified folder cannot be found.
     40 NOTES::
    4141
    42 '''NOTES'''
     42 EXAMPLE::
     43     {{{#!arexx
     44     /* Enable result codes */
     45     OPTIONS RESULTS
    4346
    44 '''EXAMPLE'''
    45          /* Enable result codes */
     47     /* Request info */
     48     FOLDERINFO 'Incoming' STEM fi.
    4649
    47          OPTIONS RESULTS
     50     /* Display results */
     51     SAY 'Folder number:   'fi.number
     52     SAY 'Folder name:     'fi.name
     53     SAY 'Path:            'fi.path
     54     SAY 'Total messages:  'fi.total
     55     SAY 'New messages:    'fi.new
     56     SAY 'Unread messages: 'fi.unread
     57     SAY 'Total size:      'fi.size
     58     SAY 'Type:            'fi.type
     59     }}}
    4860
    49          /* Request info */
     61 BUGS::
    5062
    51          FOLDERINFO 'Incoming' STEM fi.
    52 
    53          /* Display results */
    54 
    55          SAY 'Folder number:   'fi.number\\
    56          SAY 'Folder name:     'fi.name\\
    57          SAY 'Path:            'fi.path\\
    58          SAY 'Total messages:  'fi.total\\
    59          SAY 'New messages:    'fi.new\\
    60          SAY 'Unread messages: 'fi.unread\\
    61          SAY 'Total size:      'fi.size\\
    62          SAY 'Type:            'fi.type\\
    63 
    64 '''BUGS'''
    65 
    66 '''SEE ALSO'''
     63 SEE ALSO::