INI GET()

From Recital Documentation Wiki
Revision as of 13:30, 3 November 2009 by Yvonnemilne (Talk | contribs)

Jump to: navigation, search

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 value to return if key does not exist
<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)
# end of test.ini
key1value = ini_get('global','key1',

Products