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


Ignore:
Timestamp:
Feb 4, 2014 7:08:34 PM (7 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/GETCONFIGINFO

    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== GETCONFIGINFO 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     GetConfigInfo -- Return information about the current user.  (V1.3) 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     VAR/K,STEM/K,ITEM/A 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Returns information about the current user. 
    1413 
    15 '''INPUTS''' 
    16      VAR/K    - alternative variable to put the results into instead of RESULT  (V2.0)\\ 
    17      STEM/K   - base name used for the stem where the result will be stored  (V2.0)\\ 
    18      ITEM/A   - item to return information about, may be one of 
     14 INPUTS:: 
     15     `VAR/K`    - alternative variable to put the results into instead of RESULT  (V2.0)\\ 
     16     `STEM/K`   - base name used for the stem where the result will be stored  (V2.0)\\ 
     17     `ITEM/A`   - item to return information about, may be one of 
    1918 
    20                    EMA(IL)   - e-mail address\\ 
    21                    NAM(E)    - real name\\ 
     19                   `EMA(IL)`   - e-mail address\\ 
     20                   `NAM(E)`    - real name\\ 
    2221 
    23 '''RETURNS''' 
    24      VAR         - info returned by the query\\ 
    25      <STEM>VALUE - info returned by the query\\ 
     22 RETURNS:: 
     23     `VAR`         - info returned by the query\\ 
     24     `<STEM>VALUE` - info returned by the query\\ 
    2625 
    27 '''NOTES''' 
    28      Superseded by [[ARexx API/USERINFO| USERINFO ]] in V2.0+.  Don't use it in new scripts. 
     26 NOTES:: 
     27     Superseded by [[USERINFO]] in V2.0+.  Don't use it in new scripts. 
    2928 
    30 '''EXAMPLE''' 
    31          /* Enable result codes */ 
     29 EXAMPLE:: 
     30     {{{#!urbiscript 
     31     /* Enable result codes */ 
     32     OPTIONS RESULTS 
    3233 
    33          OPTIONS RESULTS 
     34     /* Request info */ 
     35     GETCONFIGINFO NAME VAR name\\ 
     36     GETCONFIGINFO EMAIL VAR email\\ 
    3437 
    35          /* Request info */ 
     38     /* Display results */ 
     39     SAY 'User name:    'name\\ 
     40     SAY 'User address: 'email\\ 
     41     }}} 
    3642 
    37          GETCONFIGINFO NAME VAR name\\ 
    38          GETCONFIGINFO EMAIL VAR email\\ 
    39  
    40          /* Display results */ 
    41  
    42          SAY 'User name:    'name\\ 
    43          SAY 'User address: 'email\\ 
    44  
    45 '''BUGS''' 
     43 BUGS:: 
    4644     The original V1.3 implementation would return junk most of the time; 
    4745     this was fixed in V1.3.1. 
    4846 
    49 '''SEE ALSO''' 
    50      [[ARexx API/USERINFO| USERINFO ]] 
     47 SEE ALSO:: 
     48     [[USERINFO]]