Difference between revisions of "INI GET()"

From Recital Documentation Wiki
Jump to: navigation, search
Line 22: Line 22:
 
|<expC2>||Name of the key
 
|<expC2>||Name of the key
 
|-
 
|-
|<expC3>||Default value to return if key does not exist
+
|<expC3>||Default value to return if key does not exist. If this optional parameter is not included, an empty string is returned for a non-existent key.
 
|-
 
|-
|<expC4>||Name of the ini file
+
|<expC4>||Name of the ini file.  If this optional parameter it not included, the filename defaults to the recital system configuration file, recital.conf
 
|-
 
|-
|<expL>||.T. to expand macros, .F. to return macros without expanding
+
|<expL>||.T. to expand macros, .F. to return macros without expanding.  If this optional parameter is not included, macro expansion defaults to .T.
 
|}
 
|}
  

Revision as of 13:45, 3 November 2009

Purpose

Function to return the value from a key in a specified section of an 'ini' file


Syntax

INI_GET(<expC1>, <expC2>[, <expC3>[, <expC4>[, <expL>]]])


See Also

INI_GETSECTION(), INI_SET(), INI_SETSECTION()


Description

The INI_GET() function returns the value from an individual key in a specified section of an 'ini' file. The value is returned as a character string.


Parameter Description
<expC1> Name of the section
<expC2> Name of the key
<expC3> Default value to return if key does not exist. If this optional parameter is not included, an empty string is returned for a non-existent key.
<expC4> Name of the ini file. If this optional parameter it not included, the filename defaults to the recital system configuration file, recital.conf
<expL> .T. to expand macros, .F. to return macros without expanding. If this optional parameter is not included, macro expansion defaults to .T.


Example

# test.ini
# comment lines are preceeded by a '#' 
; or a ';'
#
# "Sections" are enclosed in [ and ]
[global]
; key/value pairs are contained in the sections and are written like this
 	key1 = value
 	key2 = value2
; You can include macros in the key/value pairs.
 	key3 = This is $(key2) and $(key1)
# end of test.ini
key1value = ini_get('global','key1','unset','test.ini,.T.)


Products

Recital, Recital Server