Changes between Version 4 and Version 6 of Documentation/ARexxAPI/WRITEATTACH


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/WRITEATTACH

    v4 v6  
    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== WRITEATTACH 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     WriteAttach -- Attach a file to a new message. 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     FILE/A,DESC,ENCMODE,CTYPE 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Attaches a file to a new message. 
    1413 
    15 '''INPUTS''' 
    16      FILE/A    - filename to attach, with path\\ 
    17      DESC      - optional, string with a description for the file  (V1.3)\\ 
    18      ENCMODE   - optional, encoding type for the file; may be either "uu" or "b64"  (V1.3)\\ 
    19      CTYPE     - optional, content type of the file  (V1.3)\\ 
     14 INPUTS:: 
     15     `FILE/A`    - filename to attach, with path\\ 
     16     `DESC`      - optional, string with a description for the file  (V1.3)\\ 
     17     `ENCMODE`   - optional, encoding type for the file; may be either "uu" or "b64"  (V1.3)\\ 
     18     `CTYPE`     - optional, content type of the file  (V1.3)\\ 
    2019 
    21 '''RETURNS''' 
    22      RC is set to 10 if no Write window was previously specified as 
    23      "active" with [[ARexx API/MAILWRITE| MAILWRITE ]]. 
     20 RETURNS:: 
     21     `RC` is set to 10 if no Write window was previously specified as 
     22     "active" with [[MAILWRITE]]. 
    2423 
    25 '''NOTES''' 
     24 NOTES:: 
    2625     By default, binary files are encoded as Base64 (MIME), whereas 
    2726     text files are UUencoded. 
     
    3231     defined "application/pgs" as MIME type for files using the 
    3332     ".pgs" extension, all files attached bearing this extension 
    34      will default to "application/pgs" unless CTYPE overrides this. 
     33     will default to "application/pgs" unless `CTYPE` overrides this. 
    3534     If no suitable MIME type is found and no content type has been 
    3635     specified, YAM will fallback to "application/octet-stream". 
    3736 
    38 '''EXAMPLE''' 
    39          /* Attach a file */ 
     37 EXAMPLE:: 
     38     {{{#!arexx 
     39     /* Set the active Write window */ 
     40     MAILWRITE WINDOW 0 
    4041 
    41          MAILWRITE WINDOW 0      /* Set the active Write window */\\ 
    42          WRITEATTACH 'Docs:Mag.pgs' ENCMODE 'b64' CTYPE 'application/pgs'\\ 
     42     /* Attach a file */ 
     43     WRITEATTACH 'Docs:Mag.pgs' ENCMODE 'b64' CTYPE 'application/pgs' 
     44     }}} 
    4345 
    44 '''BUGS''' 
     46 BUGS:: 
    4547     No error is returned if the specified file was found but couldn't 
    4648     be opened. 
    4749 
    48 '''SEE ALSO''' 
    49      [[ARexx API/MAILWRITE| MAILWRITE ]] 
     50 SEE ALSO:: 
     51     [[MAILWRITE]]