Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

VRage.Game.ModAPI.Ingame.Utilities.MyIni

Malware edited this page Dec 25, 2018 · 55 revisions

Index

MyIni Class

public class MyIni: object

Namespace: VRage.Game.ModAPI.Ingame.Utilities
Assembly: VRage.Game.dll

Inheritance: object

Example

Remarks

Properties

Member Description
EndContent You can terminate a configuration stream by entering "---" on a separate line. This property will contain all the content after this line.
EndComment Get or set a comment to be placed after the last section or item. Isnullif the section does not exist or has no comment.

Methods

Member Description
HasSection(string, string) Determines if the given configuration contains what looks like the given section. It does not verify that the content is actually in a valid format, just if there's a line starting with [section].
ContainsSection(string) Determines whether a section of a given name exists in the currently parsed configuration.
ContainsKey(string, string) Determines whether a configuration key (section/key) exists in the currently parsed configuration.
ContainsKey(MyIniKey) Determines whether a configuration key (section/key) exists in the currently parsed configuration.
GetKeys(string, List)
GetKeys(List)
GetSections(List)
SetEndComment(string) Sets a comment to be placed after the last section or item. Set the comment tonullto remove it.
GetSectionComment(string) Get any comment that might be associated with the given section. Returnsnullif the section does not exist or has no comment.
SetSectionComment(string, string) Sets a comment on a given section. The section must already exist. Set the comment tonullto remove it.
GetComment(string, string) Gets any comment that might be associated with the given key. Returnsnullif the key does not exist or has no comment.
GetComment(MyIniKey) Gets any comment that might be associated with the given key. Returnsnullif the key does not exist or has no comment.
SetComment(string, string, string) Sets a comment on a given item. The item must already exist. Set the comment tonullto remove it.
SetComment(MyIniKey, string) Sets a comment on a given item. The item must already exist. Set the comment tonullto remove it.
Get(string, string) Gets the MyIniValue of the given configuration key.
Get(MyIniKey) Gets the MyIniValue of the given configuration key.
Delete(string, string) Deletes the given configuration key.
Delete(MyIniKey) Deletes the given configuration key.
Set(string, string, string) Sets the value of the given configuration key.
Set(MyIniKey, string) Sets the value of the given configuration key.
Set(string, string, bool) Sets the value of the given configuration key.
Set(MyIniKey, bool) Sets the value of the given configuration key.
Set(string, string, byte) Sets the value of the given configuration key.
Set(MyIniKey, byte) Sets the value of the given configuration key.
Set(string, string, sbyte) Sets the value of the given configuration key.
Set(MyIniKey, sbyte) Sets the value of the given configuration key.
Set(string, string, ushort) Sets the value of the given configuration key.
Set(MyIniKey, ushort) Sets the value of the given configuration key.
Set(string, string, short) Sets the value of the given configuration key.
Set(MyIniKey, short) Sets the value of the given configuration key.
Set(string, string, uint) Sets the value of the given configuration key.
Set(MyIniKey, uint) Sets the value of the given configuration key.
Set(string, string, int) Sets the value of the given configuration key.
Set(MyIniKey, int) Sets the value of the given configuration key.
Set(string, string, ulong) Sets the value of the given configuration key.
Set(MyIniKey, ulong) Sets the value of the given configuration key.
Set(string, string, long) Sets the value of the given configuration key.
Set(MyIniKey, long) Sets the value of the given configuration key.
Set(string, string, float) Sets the value of the given configuration key.
Set(MyIniKey, float) Sets the value of the given configuration key.
Set(string, string, double) Sets the value of the given configuration key.
Set(MyIniKey, double) Sets the value of the given configuration key.
Set(string, string, decimal) Sets the value of the given configuration key.
Set(MyIniKey, decimal) Sets the value of the given configuration key.
Clear() Empties this configuration
TryParse(string) Attempts to parse the given content as a configuration file.
TryParse(string, ref MyIniParseResult) Attempts to parse the given content as a configuration file.
TryParse(string, string, ref MyIniParseResult) Attempts to parse the given content as a configuration file. OBSERVE: Use only for read-only operations. If you parse a single section and run ToString() , you will only get the parsed section, the rest will be discarded.
TryParse(string, string) Attempts to parse the given content as a configuration file. OBSERVE: Use only for read-only operations. If you parse a single section and run ToString() , you will only get the parsed section, the rest will be discarded.
Invalidate() Forces regeneration of the ini content. Only really useful if you want to reformat the configuration file.
ToString() Generates a configuration file from the currently parsed configuration
Clone this wiki locally