Difference between revisions of "IniReadRef"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Speedo
(New page: {{Beta}} A command for Pluggy. '''Syntax:''' <pre> (Value:ref) IniReadInt FileStringID:long SectionStringID:long KeyStringID:long DefaultValu...)
 
imported>Quetzilla
m (typo)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Beta}}
A command for [[:Category: Pluggy|Pluggy]].
A command for [[:Category: Pluggy|Pluggy]].


'''Syntax:'''
'''Syntax:'''
<pre>
<pre>
(Value:ref) IniReadInt FileStringID:long SectionStringID:long KeyStringID:long
(Value:ref) IniReadRef FileStringID:long SectionStringID:long KeyStringID:long
                       DefaultValue:ref
                       DefaultValue:ref
</pre>
</pre>
Line 13: Line 11:


*DefaultValue '''must''' be a local ref variable.
*DefaultValue '''must''' be a local ref variable.
*If the Key is not found, DefaultValue is returned.
*If the Key is not found or is invalid, DefaultValue is returned.
*References must be stored as [[FormID|FormIDs]] to be read with '''IniReadRef'''.
 
==See Also==
*[[Pluggy INI Files]]


[[Category: Functions (Pluggy)]]
[[Category: Functions (Pluggy)]]
[[Category: File Functions (Pluggy)]]
[[Category: File Functions (Pluggy)]]

Latest revision as of 10:55, 11 August 2008

A command for Pluggy.

Syntax:

(Value:ref) IniReadRef FileStringID:long SectionStringID:long KeyStringID:long
                       DefaultValue:ref

Note: All arguments should be on the same line.

Finds the specified Key in an Ini file and returns its Value as a reference.

  • DefaultValue must be a local ref variable.
  • If the Key is not found or is invalid, DefaultValue is returned.
  • References must be stored as FormIDs to be read with IniReadRef.

See Also[edit | edit source]