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


Ignore:
Timestamp:
Feb 5, 2014 3:53:26 PM (10 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/USERINFO

    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== USERINFO 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     UserInfo -- Return details about the user currently logged in. (V2.0) 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     VAR/K,STEM/K 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Returns details about the user currently logged in. 
    1413 
    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\\ 
     14 INPUTS:: 
     15     `VAR/K`    - alternative variable to put the results into instead of `RESULT`\\ 
     16     `STEM/K`   - base name used for the stems where the results will be stored\\ 
    1817 
    19 '''RETURNS''' 
    20      VAR            - info returned by the query\\ 
    21      <STEM>USERNAME - user name of this user\\ 
    22      <STEM>EMAIL    - email address of this user\\ 
    23      <STEM>REALNAME - real name of this user\\ 
    24      <STEM>CONFIG   - configuration file of this user\\ 
    25      <STEM>MAILDIR  - mail directory of this user\\ 
    26      <STEM>FOLDERS  - current number of entries in the folder list; groups will be ignored  (V2.1)\\ 
     18 RETURNS:: 
     19     `VAR`            - info returned by the query\\ 
     20     `<STEM>USERNAME` - user name of this user\\ 
     21     `<STEM>EMAIL`    - email address of this user\\ 
     22     `<STEM>REALNAME` - real name of this user\\ 
     23     `<STEM>CONFIG`   - configuration file of this user\\ 
     24     `<STEM>MAILDIR`  - mail directory of this user\\ 
     25     `<STEM>FOLDERS`  - current number of entries in the folder list; groups will be ignored  (V2.1)\\ 
    2726 
    28 '''NOTES''' 
     27 NOTES:: 
    2928 
    30 '''EXAMPLE''' 
     29 EXAMPLE:: 
    3130 
    32 '''BUGS''' 
     31 BUGS:: 
    3332 
    34 '''SEE ALSO''' 
     33 SEE ALSO::