Difference between revisions of "INI GET()"

From Recital Documentation Wiki
Jump to: navigation, search
 
Line 1: Line 1:
 
{{YLM to do}}
 
{{YLM to do}}
 +
==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.
 +
 +
{| class="wikitable"
 +
!Parameter||Description
 +
|-
 +
|<expC1>||Name of the section
 +
|-
 +
|<expC2>||Name of the key
 +
|-
 +
|<expC3>||Default
 +
|-
 +
|<expC4>||Name of the ini file
 +
|-
 +
|<expL>||.T. if macros should be expanded, .F. if macros should not be expanded
 +
|}
 +
 +
 +
==Example==
 +
<code lang="bash">
 +
# 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)
 +
 +
</code>
 +
<code lang="recital">
 +
key1value = ini_get('global','key1',
 +
</code>
 +
 +
==Products==

Revision as of 12:04, 3 November 2009

Template:YLM to do

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
<expC4> Name of the ini file
<expL> .T. if macros should be expanded, .F. if macros should not be expanded


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)
key1value = ini_get('global','key1',

Products