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


Ignore:
Timestamp:
Sep 23, 2013, 8:43:15 PM (15 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/READINFO

    v1 v1  
     1== READINFO
     2
     3'''NAME'''
     4     ReadInfo -- Return information about the attachments of the message in the active Read window.  (V2.0)
     5
     6'''TEMPLATE'''
     7     VAR/K,STEM/K
     8
     9'''FUNCTION'''
     10     Returns information about the attachments of the message in the
     11     active Read window as set by [[rx_mailread| MAILREAD ]].
     12
     13'''INPUTS'''
     14     VAR/K    - alternative variable to put the results into instead of RESULT\\
     15     STEM/K   - base name used for the stems where the results will be stored\\
     16
     17'''RETURNS'''
     18     VAR                  - info returned by the query\\
     19     <STEM>FILENAME.COUNT - number of parts of the message, excluding the first header block\\
     20     <STEM>FILENAME.NR    - filename of the nth part of the message, where nr is a number between 0 and n-1 (0 = first part after the headers, usually the body of the message)\\
     21     <STEM>FILETYPE.NR    - content type of the nth part of the message, where nr is a number between 0 and n-1 (0 = first part after the headers, usually the body of the message)\\
     22     <STEM>FILESIZE.NR    - size of the nth part of the message, where nr is a number between 0 and n-1 (0 = first part after the headers, usually the body of the message)\\
     23     <STEM>TEMPFILE.NR    - temporary file where the nth part of the message is stored, nr being a number between 0 and n-1 (0 = first part after the headers, usually the body of the message)\\
     24
     25     RC is set to 10 if no Read window was previously specified as "active"
     26     with [[rx_mailread| MAILREAD ]].
     27
     28'''NOTES'''
     29     No filename is returned for the body of the message.
     30
     31'''EXAMPLE'''
     32         /* Enable result codes */
     33
     34         OPTIONS RESULTS
     35
     36         /* Silently decode the current message */
     37
     38         MAILREAD QUIET
     39
     40         /* Get info about the message, then close the window */
     41
     42         READINFO STEM ri.\\
     43         READCLOSE\\
     44
     45         /* Display results */
     46
     47         DO i = 0 TO ri.filename.count-1\\
     48            SAY 'Information about part #'i+1\\
     49            SAY '  File name: 'ri.filename.i\\
     50            SAY '  File type: 'ri.filetype.i\\
     51            SAY '  File size: 'ri.filesize.i\\
     52            SAY '  Stored in: 'ri.tempfile.i\\
     53         END\\
     54
     55'''BUGS'''
     56     The command used to blindly act upon the first Read window opened
     57     at any given time; this was changed in V2.4 to require the use
     58     of [[rx_mailread| MAILREAD ]] to explicitely mark a window as "active".
     59
     60'''SEE ALSO'''
     61     [[rx_mailread| MAILREAD ]]