home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 1 / FishNMoreVol1.bin / more / programming / arpprog / newdocs / getenv < prev    next >
Text File  |  1988-02-22  |  1KB  |  67 lines
  1.  
  2.  
  3.  
  4.      GetEnv(33.4)      ARP Programmers Manual      GetEnv(33.4)
  5.  
  6.  
  7.  
  8.      NAME
  9.       GetEnv -- Get    the value of an    environment variable
  10.  
  11.      SYNOPSIS
  12.       strptr = Getenv("string", buffer, size)
  13.         d0            A0          A1     d0
  14.  
  15.      FUNCTION
  16.       This function    provides an environment    variable mechanism
  17.       compatible with MANX.     Note that this    call is    more efficient
  18.       than using the manx getenv() function    call when arplibrary
  19.       is installed.
  20.  
  21.      INPUTS
  22.       string -- pointer to an environment variable name.
  23.  
  24.       buffer -- a user allocated area which    will be    used to    store
  25.           the value associated with the    environment variable.
  26.           This may be NULL.
  27.  
  28.       size -- size of buffer region    in bytes.
  29.  
  30.      RESULT
  31.       If found, a pointer to the start of the value    string for
  32.       that variable    will be    returned.  If buffer is    non-null, then
  33.       as much of the value string as allowed by size will be
  34.       copied into the user buffer.
  35.  
  36.      ADDTIONAL CONSIDERATIONS
  37.       arp.libraries    environment variable mechanism is compatible
  38.       with the MANX    software, which    has set    the defacto standard
  39.       implementation for the Amiga.     This call is NOT equivalent
  40.       to the Manx getenv() call, however.
  41.  
  42.       You should run as Forbidden()    any code that uses or examines
  43.       the return value from    this function, which is    a pointer to
  44.       the global environment space of ArpLib.
  45.  
  46.      BUGS
  47.       None Known.
  48.  
  49.      SEE ALSO
  50.       SetEnv()
  51.  
  52.      AUTHOR
  53.       SDB
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 2/22/88)
  64.  
  65.  
  66.  
  67.