Difference between revisions of "INI GET()"
From Lianjapedia
Helen.george (Talk | contribs) |
|||
Line 1: | Line 1: | ||
==Purpose== | ==Purpose== | ||
Function to return the value from a key in a specified section of an 'ini' file | Function to return the value from a key in a specified section of an 'ini' file | ||
− | |||
==Syntax== | ==Syntax== | ||
INI_GET(<expC1>, <expC2>, <expC3>, <expC4>[, <expL>]) | INI_GET(<expC1>, <expC2>, <expC3>, <expC4>[, <expL>]) | ||
− | |||
==See Also== | ==See Also== | ||
[[INI_GETSECTION()]], [[INI_SET()]], [[INI_SETSECTION()]] | [[INI_GETSECTION()]], [[INI_SET()]], [[INI_SETSECTION()]] | ||
− | |||
==Description== | ==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. | 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" | {| class="wikitable" | ||
Line 28: | Line 24: | ||
|<expL>||.T. to expand macros, .F. to return macros without expanding. If this optional parameter is not included, macro expansion defaults to .F. (false). | |<expL>||.T. to expand macros, .F. to return macros without expanding. If this optional parameter is not included, macro expansion defaults to .F. (false). | ||
|} | |} | ||
− | |||
==Example== | ==Example== | ||
Line 48: | Line 43: | ||
key1value = ini_get('global','key1','unset','test.ini',.T.) | key1value = ini_get('global','key1','unset','test.ini',.T.) | ||
</code> | </code> | ||
− | |||
==Products== | ==Products== |
Revision as of 12:43, 11 December 2012
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. |
<expC4> | Name of the ini file. |
<expL> | .T. to expand macros, .F. to return macros without expanding. If this optional parameter is not included, macro expansion defaults to .F. (false). |
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
Lianja, Lianja Server