Skip to content

Documentation ARexxAPI GETCONFIGINFO

Jens Maus edited this page Feb 13, 2017 · 1 revision

GETCONFIGINFO

NAME:: GetConfigInfo -- Return information about the current user. (V1.3)

TEMPLATE:: VAR/K,STEM/K,ITEM/A

FUNCTION:: Returns information about the current user.

INPUTS:: VAR/K - alternative variable to put the results into instead of RESULT (V2.0)\ STEM/K - base name used for the stem where the result will be stored (V2.0)\ ITEM/A - item to return information about, may be one of - EMA(IL) - e-mail address - NAM(E) - real name

RETURNS:: VAR - info returned by the query\ <STEM>VALUE - info returned by the query\

NOTES:: Superseded by USERINFO in V2.0+. Don't use it in new scripts.

EXAMPLE:: {{{#!arexx /* Enable result codes */ OPTIONS RESULTS

 /* Request 'name' info */
 GETCONFIGINFO NAME VAR name
 IF RC ~= 0 THEN EXIT

 /* Request 'email' info */
 GETCONFIGINFO EMAIL VAR email
 IF RC ~= 0 THEN EXIT

 /* Display results */
 SAY 'User name:    'name
 SAY 'User address: 'email
 }}}

BUGS:: The original V1.3 implementation would return junk most of the time; this was fixed in V1.3.1.

SEE ALSO:: USERINFO

Home

Getting Started

Troubleshooting

Advanced use of YAM

Cookbooks

Development

Clone this wiki locally