Difference between revisions of "GETENV()"

From Recital Documentation Wiki
Jump to: navigation, search
 
Line 12: Line 12:
  
 
==See Also==
 
==See Also==
[[ACCESS()]], [[GETGID()]], [[GETLOG()]], [[GETPID()]], [[GETUID()]], [[PUTENV()]], [[PUTLOG()]]
+
[[ACCESS()]], [[ADDBS()]], [[GETGID()]], [[GETLOG()]], [[GETPID()]], [[GETUID()]], [[:Category:Printing|Printing]], [[PUTENV()]], [[PUTLOG()]]
  
  
 
==Description==
 
==Description==
The GETENV() function returns the value of the environment variable <expC>.  Its main purpose is to pass information into Recital (e.g. from DCL command procedures, or UNIX/Linux shell scripts).  In UNIX, Linux and Windows it returns the value of an environment variable.  In OpenVMS, it returns the value of a DCL symbol.  When used in conjunction with the PUTENV() function, the GETENV() function is very useful for passing parameters to Recital programs spawned in the background.
+
The GETENV() function returns the value of the environment variable <expC>.  Its main purpose is to pass information into Recital (e.g. from DCL command procedures, or UNIX/Linux shell scripts).  In UNIX, Linux and Windows it returns the value of an environment variable.  In OpenVMS, it returns the value of a DCL symbol.
  
  
 
==Example==
 
==Example==
 
<code lang="recital">
 
<code lang="recital">
? getenv("file")
+
? getenv("APP_FILE")
 
/usr/recital/patrons.dbf
 
/usr/recital/patrons.dbf
 
</code>
 
</code>
Line 30: Line 30:
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Environment]]
 +
[[Category:Environment Functions]]

Revision as of 11:33, 9 June 2009

Class

Environment


Purpose

Function to get environment information


Syntax

GETENV(<expC>)


See Also

ACCESS(), ADDBS(), GETGID(), GETLOG(), GETPID(), GETUID(), Printing, PUTENV(), PUTLOG()


Description

The GETENV() function returns the value of the environment variable <expC>. Its main purpose is to pass information into Recital (e.g. from DCL command procedures, or UNIX/Linux shell scripts). In UNIX, Linux and Windows it returns the value of an environment variable. In OpenVMS, it returns the value of a DCL symbol.


Example

? getenv("APP_FILE")
/usr/recital/patrons.dbf


Products

Recital Database Server, Recital Mirage Server, Recital Terminal Developer