Read Environment Variable

Subroutine Name Executable Example Viewable Example

W3READ-ENVIRONMENT-ARRAY
W3READ-ENVIRONMENT
W3READ-ENVIRONMENT-TO-DYNAMIC

E3ENVARY

E3ENVARY

Description

Reads the first occurrence of a single variable. With W3READ-ENVIRONMENT-ARRAY, a variable can be read beginning with an offset. This can be used to read multiple occurrences of the same variable.

Parameters
  1. W3READ-ENVIRONMENT-ARRAY

    1 W3START        (I4)       /* io/m : Offset to be started at
    *                           /*        out: 0 no occurrences
    *                           /*        out: >0 more occurrences
    1 W3NAME         (A072)     /* i /m : Name of the variable to
    *                           /*        be searched for
    1 W3VALUESERVER  (A1)       /* i /m : Search for variables from
    *                           /*        'S' server
    *                           /*        'P' page or URL
    *                           /*        ' ' both
    1 W3ARRAYCOUNTER (I4)       /* io/m : Size of array,
                                /*        characters read
    1 W3VALUEARRAY   (A001/1:V) /*  o/m : Array with the returned value
    1 W3VALUELENGTH  (I4)       /*  o/m : length of the value 
    
  2. W3READ-ENVIRONMENT

    1 W3NAME        (A072) /* i /m : Name of the variable
                           /*        searched for
    1 W3VALUESERVER (A1)   /* i /m : Search for variables in   
    *                      /*        'S' server
    *                      /*        'P' page or URL
    *                      /*        ' ' both
    1 W3VALUE       (A250) /*  o/m : Returned value
    1 W3VALUELENGTH (I4)   /*  o/m : Length of the value
    
  3. W3READ-ENVIRONMENT-TO-DYNAMIC

    1 W3NAME         (A072)      /* i /m : Name of the variable
                                 /*        searched for
    1 W3VALUESERVER  (A1)        /* i /m : Search for variables in
    *                            /*        'S' server
    *                            /*        'P' page or URL
    *                            /*        ' ' both
    1 W3VALUEDYNAMIC (A) DYNAMIC /* o/m : Returned value
    
How To Invoke
PERFORM W3READ-ENVIRONMENT-ARRAY W3START W3NAME
        W3VALUESERVER W3ARRAYCOUNTER
        W3VALUEARRAY(*) W3VALUELENGTH

PERFORM W3READ-ENVIRONMENT W3NAME W3VALUESERVER W3VALUE
        W3VALUELENGTH

PERFORM W3READ-ENVIRONMENT-TO-DYNAMIC W3NAME W3VALUESERVER
        W3VALUEDYNAMIC