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


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

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/GETFOLDERINFO

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