Changes between Initial Version and Version 1 of Documentation/ARexxAPI/FOLDERINFO


Ignore:
Timestamp:
Sep 22, 2013, 9:49:16 PM (15 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/FOLDERINFO

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