ev_$read_var_entry

EV_$READ_VAR_ENTRY                Domain/OS                 EV_$READ_VAR_ENTRY


NAME
     ev_$read_var_entry - read an environment entry

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/ev.h>

     extern boolean ev_$read_var_entry(
          short *environment_index,
          char **name_ptr,
          short *name_length,
          char **value_ptr,
          short *value_length)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/ev.ins.pas';

     function ev_$read_var_entry(
          var environment_index: integer;
          out name_ptr: ev_$string_ptr_t;
          out name_length: integer;
          out value_ptr: ev_$string_ptr_t;
          out value_length: integer): boolean;

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/ev.ins.ftn'

           integer*2 environment_index, name_length, value_length
           character name*256, value*256
           logical entry_exists

           integer*4 name_ptr, value_ptr
           pointer /name_ptr/ name
           pointer /value_ptr/ value

           entry_exists = ev_$read_var_entry(environment_index,
          &                                  name_ptr, name_length,
          &                                  value_ptr, value_length)

DESCRIPTION
     Ev_$read_var_entry reads the environment entry specified by
     environment_index and, if it exists, supplies pointers to the name and
     value for that entry in name_ptr and value_ptr.  Ev_$read_var_entry
     returns true if the entry specified by environment_index exists, or false
     otherwise.

     environment_index
          An index into the list of environment variables.  The first variable
          in the environment has the index 1.

     name_ptr
          A pointer to the name of the environment entry.

     name_length
          The number of bytes in the name of the environment variable at
          name_ptr.

     value_ptr
          A pointer to the value of the environment entry.

     value_length
          The number of bytes in the value of the environment variable at
          value_ptr.
Museum
