INI GETSECTION()

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

Jump to: navigation, search

Purpose

Function to return all the key / value pairs from a specified section of an 'ini' file


Syntax

INI_GETSECTION(<expC1>[, <expC2>[, <expL>]])


See Also

INI_GET(), INI_SET(), INI_SETSECTION()


Description

The INI_GETSECTION() function returns all the key / value pairs from a specified section of an 'ini' file. The value is returned as an object.


Parameter Description
<expC1> Name of the section.
<expC2> 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 .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
obj_global = ini_getsection('global','test.ini')
? obj_global.key3
This is $(key2) and $(key1)


Products

Recital, Recital Server