Skip to content
This repository was archived by the owner on Dec 13, 2025. It is now read-only.

VRage.Game.ModAPI.Ingame.Utilities.MyIniValue

Malware edited this page Dec 21, 2018 · 51 revisions

Index

MyIniValue Struct

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

Summary

Represents the value of a single configuration item.

Fields

Member Description
MyIniKey Key Gets the MyIniKey this value was retrieved from
static MyIniValue EMPTY Represents an empty MyIniValue

Properties

Member Description
bool IsEmpty Determines whether this value is empty. Be aware that an empty string is not considered to be an empty value.

Methods

Member Description
bool ToBoolean(bool defaultValue) Attempts to get this value as a System.Boolean . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetBoolean(ref bool value) Attempts to get this value as a System.Boolean . Fills thevalueon success.
char ToChar(char defaultValue) Attempts to get this value as a System.Char . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetChar(ref char value) Attempts to get this value as a System.Char . Fills thevalueon success.
sbyte ToSByte(sbyte defaultValue) Attempts to get this value as a System.SByte . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetSByte(ref sbyte value) Attempts to get this value as a System.SByte . Fills thevalueon success.
byte ToByte(byte defaultValue) Attempts to get this value as a System.Byte . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetByte(ref byte value) Attempts to get this value as a System.Byte . Fills thevalueon success.
ushort ToUInt16(ushort defaultValue) Attempts to get this value as a System.UInt16 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetUInt16(ref ushort value) Attempts to get this value as a System.UInt16 . Fills thevalueon success.
short ToInt16(short defaultValue) Attempts to get this value as a System.Int16 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetInt16(ref short value) Attempts to get this value as a System.Int16 . Fills thevalueon success.
uint ToUInt32(uint defaultValue) Attempts to get this value as a System.UInt32 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetUInt32(ref uint value) Attempts to get this value as a System.UInt32 . Fills thevalueon success.
int ToInt32(int defaultValue) Attempts to get this value as a System.Int32 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetInt32(ref int value) Attempts to get this value as a System.Int32 . Fills thevalueon success.
ulong ToUInt64(ulong defaultValue) Attempts to get this value as a System.UInt64 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetUInt64(ref ulong value) Attempts to get this value as a System.UInt64 . Fills thevalueon success.
long ToInt64(long defaultValue) Attempts to get this value as a System.Int64 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetInt64(ref long value) Attempts to get this value as a System.Int64 . Fills thevalueon success.
float ToSingle(float defaultValue) Attempts to get this value as a System.Single . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetSingle(ref float value) Attempts to get this value as a System.Single . Fills thevalueon success.
double ToDouble(double defaultValue) Attempts to get this value as a System.Double . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetDouble(ref double value) Attempts to get this value as a System.Double . Fills thevalueon success.
decimal ToDecimal(decimal defaultValue) Attempts to get this value as a System.Decimal . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetDecimal(ref decimal value) Attempts to get this value as a System.Decimal . Fills thevalueon success.
void GetLines(List<string> lines) Retrieves each individual line of this value into the provided list.
string ToString() Attempts to get this value as a System.String . If the value is empty or cannot be understood as this data type, an empty string will be returned instead.
string ToString(string defaultValue) Attempts to get this value as a System.String . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
bool TryGetString(ref string value) Attempts to get this value as a System.String . Fills thevalueon success.
void Write(StringBuilder stringBuilder) Writes this value as a string to the given string builder.

Clone this wiki locally