Difference between revisions of "GetINISection"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Gribbleshnibit8
m (fix red links)
imported>Pintocat
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Function
{{Function
  |origin = LU
  |origin = LU
  |summary = Returns a stringmap of all keys in an INI section and their values.
  |summary = Returns a stringmap of all keys in an INI section and their values with 64k buffer.
  |name = GetINISection
  |name = GetINISection
  |returnType = array
  |returnType = array
Line 13: Line 13:
   |Optional = y
   |Optional = y
   }}
   }}
|example=GetINISection "SectionName" "FilePath\FileName.ini"
}}
}}
==Notes==
==Notes==

Latest revision as of 22:10, 3 March 2017

< [[::Category:Functions|Category:Functions]]

A function added by the Lutana NVSE plugin.

Description

Returns a stringmap of all keys in an INI section and their values with 64k buffer.

Syntax

[help]
(array) GetINISection section:string filename:string

Example

GetINISection "SectionName" "FilePath\FileName.ini"

Notes

INI files are read from and written to in the Data\config\ folder (as in MCM's INI functions). Format Example

If no filename is specified, the name of the mod the function is called from is used. Subdirectories can be defined in the path, e.g. "subDir\nameOfFile"

Writing to an INI file that does not exist will create it along with any non-existent subdirectories in its path.

A keystring is a string containing both the section and key in the format: "Section:Key" ('\' and '/' may also be used as the delimiter.)

See Also