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


Ignore:
Timestamp:
Feb 5, 2014 10:48:55 AM (10 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/READINFO

    v3 v4  
    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== READINFO 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     ReadInfo -- Return information about the attachments of the message in the active Read window.  (V2.0) 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     VAR/K,STEM/K 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Returns information about the attachments of the message in the 
    14      active Read window as set by [[ARexx API/MAILREAD| MAILREAD ]]. 
     13     active Read window as set by [[MAILREAD]]. 
    1514 
    16 '''INPUTS''' 
    17      VAR/K    - alternative variable to put the results into instead of RESULT\\ 
    18      STEM/K   - base name used for the stems where the results will be stored\\ 
     15 INPUTS:: 
     16     `VAR/K`    - alternative variable to put the results into instead of `RESULT`\\ 
     17     `STEM/K`   - base name used for the stems where the results will be stored\\ 
    1918 
    20 '''RETURNS''' 
    21      VAR                  - info returned by the query\\ 
    22      <STEM>FILENAME.COUNT - number of parts of the message, excluding the first header block\\ 
    23      <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)\\ 
    24      <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)\\ 
    25      <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)\\ 
    26      <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)\\ 
     19 RETURNS:: 
     20     `VAR`                  - info returned by the query\\ 
     21     `<STEM>FILENAME.COUNT` - number of parts of the message, excluding the first header block\\ 
     22     `<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)\\ 
     23     `<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)\\ 
     24     `<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)\\ 
     25     `<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)\\ 
    2726 
    28      RC is set to 10 if no Read window was previously specified as "active" 
    29      with [[ARexx API/MAILREAD| MAILREAD ]]. 
     27     `RC` is set to 10 if no Read window was previously specified as "active" 
     28     with [[MAILREAD]]. 
    3029 
    31 '''NOTES''' 
     30 NOTES:: 
    3231     No filename is returned for the body of the message. 
    3332 
    34 '''EXAMPLE''' 
    35          /* Enable result codes */ 
     33 EXAMPLE:: 
     34     {{{#!urbiscript 
     35     /* Enable result codes */ 
     36     OPTIONS RESULTS 
    3637 
    37          OPTIONS RESULTS 
     38     /* Silently decode the current message */ 
     39     MAILREAD QUIET 
    3840 
    39          /* Silently decode the current message */ 
     41     /* Get info about the message, then close the window */ 
     42     READINFO STEM ri. 
     43     READCLOSE 
    4044 
    41          MAILREAD QUIET 
     45     /* Display results */ 
     46     DO i = 0 TO ri.filename.count-1 
     47        SAY 'Information about part #'i+1 
     48        SAY '  File name: 'ri.filename.i 
     49        SAY '  File type: 'ri.filetype.i 
     50        SAY '  File size: 'ri.filesize.i 
     51        SAY '  Stored in: 'ri.tempfile.i 
     52     END 
     53     }}} 
    4254 
    43          /* Get info about the message, then close the window */ 
    44  
    45          READINFO STEM ri.\\ 
    46          READCLOSE\\ 
    47  
    48          /* Display results */ 
    49  
    50          DO i = 0 TO ri.filename.count-1\\ 
    51             SAY 'Information about part #'i+1\\ 
    52             SAY '  File name: 'ri.filename.i\\ 
    53             SAY '  File type: 'ri.filetype.i\\ 
    54             SAY '  File size: 'ri.filesize.i\\ 
    55             SAY '  Stored in: 'ri.tempfile.i\\ 
    56          END\\ 
    57  
    58 '''BUGS''' 
     55 BUGS:: 
    5956     The command used to blindly act upon the first Read window opened 
    6057     at any given time; this was changed in V2.4 to require the use 
    61      of [[ARexx API/MAILREAD| MAILREAD ]] to explicitely mark a window as "active". 
     58     of [[MAILREAD]] to explicitely mark a window as "active". 
    6259 
    63 '''SEE ALSO''' 
    64      [[ARexx API/MAILREAD| MAILREAD ]] 
     60 SEE ALSO:: 
     61     [[MAILREAD]]