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


Ignore:
Timestamp:
Feb 4, 2014, 5:10:26 PM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/FOLDERINFO

    v3 v4  
    1 [[TranslatedPages]]\\
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]]
    3 
     1[[TranslatedPages]][[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]]
    42== FOLDERINFO
    53
    6 '''NAME'''
     4 NAME::
    75     FolderInfo -- Return information about a folder.  (V2.0)
    86
    9 '''TEMPLATE'''
     7 TEMPLATE::
    108     VAR/K,STEM/K,FOLDER
    119
    12 '''FUNCTION'''
     10 FUNCTION::
    1311     Returns information about the specified folder, or the current
    1412     folder if none is specified.
    1513
    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)\\
     14 INPUTS::
     15     `VAR/K`    - variable where the results will be stored\\
     16     `STEM/K`   - base name used for the stems where the returned data will be stored\\
     17     `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)\\
    2018
    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:
     19 RETURNS::
     20     `VAR`          - string with a space separated list of the results of the query\\
     21     `<STEM>NUMBER` - position of the folder in the folder list; the folder at the top is in slot 0\\
     22     `<STEM>NAME`   - name of the folder as shown in the folder list\\
     23     `<STEM>PAT`   - path of the folder, e.g. "incoming"\\
     24     `<STEM>TOTAL`  - total number of messages in the folder\\
     25     `<STEM>NEW`    - number of new messages in the folder\\
     26     `<STEM>UNREAD` - number of unread messages in the folder\\
     27     `<STEM>SIZE`   - size of the folder, in bytes\\
     28     `<STEM>TYPE`   - type of folder (V2.3), possible values are:
    3129
    3230                       0 - normal\\
     
    3836                       6 - sent\\
    3937
    40      RC is set to 10 if the specified folder cannot be found.
     38     `RC` is set to 10 if the specified folder cannot be found.
    4139
    42 '''NOTES'''
     40 NOTES::
    4341
    44 '''EXAMPLE'''
    45          /* Enable result codes */
     42 EXAMPLE::
     43     {{{#!urbiscript
     44     /* Enable result codes */
     45     OPTIONS RESULTS
    4646
    47          OPTIONS RESULTS
     47     /* Request info */
     48     FOLDERINFO 'Incoming' STEM fi.
    4849
    49          /* Request info */
     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     }}}
    5060
    51          FOLDERINFO 'Incoming' STEM fi.
     61 BUGS::
    5262
    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::