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


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

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/GETCONFIGINFO

    v3 v11  
    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 
     18      - `EMA(IL)` - e-mail address 
     19      - `NAM(E)` - real name 
    1920 
    20                    EMA(IL)   - e-mail address\\ 
    21                    NAM(E)    - real name\\ 
     21 RETURNS:: 
     22     `VAR`         - info returned by the query\\ 
     23     `<STEM>VALUE` - info returned by the query\\ 
    2224 
    23 '''RETURNS''' 
    24      VAR         - info returned by the query\\ 
    25      <STEM>VALUE - info returned by the query\\ 
     25 NOTES:: 
     26     Superseded by [[USERINFO]] in V2.0+.  Don't use it in new scripts. 
    2627 
    27 '''NOTES''' 
    28      Superseded by [[ARexx API/USERINFO| USERINFO ]] in V2.0+.  Don't use it in new scripts. 
     28 EXAMPLE:: 
     29     {{{#!arexx 
     30     /* Enable result codes */ 
     31     OPTIONS RESULTS 
    2932 
    30 '''EXAMPLE''' 
    31          /* Enable result codes */ 
     33     /* Request 'name' info */ 
     34     GETCONFIGINFO NAME VAR name 
     35     IF RC ~= 0 THEN EXIT 
    3236 
    33          OPTIONS RESULTS 
     37     /* Request 'email' info */ 
     38     GETCONFIGINFO EMAIL VAR email 
     39     IF RC ~= 0 THEN EXIT 
    3440 
    35          /* Request info */ 
     41     /* Display results */ 
     42     SAY 'User name:    'name 
     43     SAY 'User address: 'email 
     44     }}} 
    3645 
    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''' 
     46 BUGS:: 
    4647     The original V1.3 implementation would return junk most of the time; 
    4748     this was fixed in V1.3.1. 
    4849 
    49 '''SEE ALSO''' 
    50      [[ARexx API/USERINFO| USERINFO ]] 
     50 SEE ALSO:: 
     51     [[USERINFO]]