Scripting/Squirrel/Functions/RemoveIniValue

From Vice City Multiplayer
Revision as of 05:20, 22 June 2016 by King (talk | contribs) (Created page with "__NOTOC__ This function deletes a selected value from an ini file. == Syntax == <code>RemoveIniValue( string FileName, string Section, string Value )</code> == Arguments ==...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing

This function deletes a selected value from an ini file.

Syntax

RemoveIniValue( string FileName, string Section, string Value )

Arguments

  • FileName - This is the file name
  • Section - The section name. Use without "[" and "]"
  • Value - What do you want delete

Example

To see how this works, let's create (again) a sample ini file 'numbers.ini'. You can copy and paste this: [no idea for name] 1 = 1 2 = fgh [spam] 2 = 1 asd = 69 [end] end = yeah

Now we want to delete the line where is '2 = 1'. Let's do this, when the server starts.

function onServerStart() {

    RemoveIniValue( "numbers.ini", "spam", "2" );

}

After this check the ini file. It should look like this: [no idea for name] 1 = 1 2 = fgh [spam] asd = 69 [end] end = yeah

Notes

The call OnServerStart was used in in this example. More info about this in the corresponding page.

Related Functions