Get_Env routine [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Get_Env routine    ======

 


 
==== Description ====
 
Returns an attribute or list of attributes from the database environment for the current database.
 
==== Syntax ====
 
**Get_Env**(//attributelist//)
 
==== Parameters ====
 
The Get_Env routine has the following parameter.

^Parameter^Description^
|//attributelist//|Specifies one or more attribute identifiers. If an attribute identifier is invalid, no value is returned for that column.|


A table of environment attributes immediately follows the description of this command. It lists the available attribute identifiers, attribute descriptions, and the data type or value that can be assigned to an attribute.\\ \\ Environment attributes are listed in the following table.


^Attribute Identifier^Attribute Description^Attribute Data Type or Value^
|1|Default data volume.|Valid volume identifier.||
|2|Sort path.|Valid drive\path.||
|3|Transaction volume.|Valid volume identifier.||
|4|Default XREF stop list.|Default stop word list.||
|5|Seconds before index update.|Integer.|
|6|Update indexes before query.|Boolean.|
|7|Unlock all at commit.|Boolean.|
|8|Deadlock recheck (seconds).|Integer.|
|9|Transaction failure timeout.|Integer.|
|10|Consistency lock level.|0 - 4.\\ \\ __Level__ __Description__\\ 0 - No implicit locking.\\ 1 - Sets exclusive locks during updates for the duration of the update.\\ 2 - Sets exclusive locks during updates for the duration of each transaction.\\ 3 - Sets exclusive locks during updates for the duration of query.\\ 4 - Sets exclusive table lock during updates and shared table lock during queries for the duration of each transaction.|
|11|Maximum allowable locks.|Integer.|
|12|Automatic transaction start.|Boolean.|
|13|Deadlock check (seconds).|Integer.|
|14|Network cache.|Integer.|
|15|Default active language set.|Valid language set name.|
|16|List of language sets to load.|Valid language set names.|
|17|Query case sensitivity.|__Value__ __Description__\\ 0 - Case sensitive.\\ 1 - Case insensitive.|
|18|TimeDate format.|Valid OConv (DT) pattern.|
|19|Suppress non-numeric errors.|Boolean.|
|20|Printer form height.|Integer.|
|21|Printer form width.|Integer.|
|22|SQL null display string.|Literal string of text.|
|23|Debugger.|__Value__ __Description__\\ 0 - Debugger disabled.\\ 1 - Debugger enabled.|
|24|Default folder for stored procedures.|Folder name.|
|25|Default I/O conversion.|__Value__ __Description__\\ 0 - No conversion performed.\\ 1 - Convert and validate.|
|26|Commit log storage volume|Volume name.|
|27|Commit protection.|__Value__ __Description__\\ 0 - Commit unprotected.\\ 1 - Commit protected.|
|28|Deadlock resolution scheme.|__Value__ __Description__\\ 0 - Rollback "youngest" transaction.\\ 1 - Rollback least active transaction.|
|29|SQL implicit lock type.|__Value__ __Description__\\ 0 - Table lock.\\ 1 - Row lock.|
|30|Coordinated locking.|__Value__ __Description__\\ 0 - No coordinated locks.\\ 1 - Table/row locks coordinated.|


The $Insert record [[environ_constants_insert_record|Environ_Constants]] defines these positions.

 
==== See Also ====
 
[[set_env|Set_Env]]
 
==== Example ====
 
<code>
/* Returns the default data volume and stop list, and debugger information from the environment for the current database. */

attributelist = "1":@FM:"4":@FM:"23"
Get_Env(attributelist)
If Get_Status(ErrCodes) Then
       GoSub ErrorHandling
End
</code>