VRage.Game.ModAPI.Ingame.Utilities.MyIniValue

← Index

MyIniValue Struct

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

Summary

Represents the value of a single configuration item.

Fields

_MyIniKey Key_	Gets the [MyIniKey](VRage.Game.ModAPI.Ingame.Utilities.MyIniKey) this value was retrieved from
static _MyIniValue EMPTY_	Represents an empty [MyIniValue](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue)

### Properties

_bool IsEmpty_

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

### Methods

_bool ToBoolean(bool defaultValue)_	Attempts to get this value as a [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.boolean?view=netframework-4.6) . Fills the`value`on success.
_char ToChar(char defaultValue)_	Attempts to get this value as a [System.Char](https://docs.microsoft.com/en-us/dotnet/api/system.char?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.char?view=netframework-4.6) . Fills the`value`on success.
_sbyte ToSByte(sbyte defaultValue)_	Attempts to get this value as a [System.SByte](https://docs.microsoft.com/en-us/dotnet/api/system.sbyte?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.sbyte?view=netframework-4.6) . Fills the`value`on success.
_byte ToByte(byte defaultValue)_	Attempts to get this value as a [System.Byte](https://docs.microsoft.com/en-us/dotnet/api/system.byte?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.byte?view=netframework-4.6) . Fills the`value`on success.
_ushort ToUInt16(ushort defaultValue)_	Attempts to get this value as a [System.UInt16](https://docs.microsoft.com/en-us/dotnet/api/system.uint16?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.uint16?view=netframework-4.6) . Fills the`value`on success.
_short ToInt16(short defaultValue)_	Attempts to get this value as a [System.Int16](https://docs.microsoft.com/en-us/dotnet/api/system.int16?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.int16?view=netframework-4.6) . Fills the`value`on success.
_uint ToUInt32(uint defaultValue)_	Attempts to get this value as a [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/system.uint32?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.uint32?view=netframework-4.6) . Fills the`value`on success.
_int ToInt32(int defaultValue)_	Attempts to get this value as a [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.int32?view=netframework-4.6) . Fills the`value`on success.
_ulong ToUInt64(ulong defaultValue)_	Attempts to get this value as a [System.UInt64](https://docs.microsoft.com/en-us/dotnet/api/system.uint64?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.uint64?view=netframework-4.6) . Fills the`value`on success.
_long ToInt64(long defaultValue)_	Attempts to get this value as a [System.Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.int64?view=netframework-4.6) . Fills the`value`on success.
_float ToSingle(float defaultValue)_	Attempts to get this value as a [System.Single](https://docs.microsoft.com/en-us/dotnet/api/system.single?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.single?view=netframework-4.6) . Fills the`value`on success.
_double ToDouble(double defaultValue)_	Attempts to get this value as a [System.Double](https://docs.microsoft.com/en-us/dotnet/api/system.double?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.double?view=netframework-4.6) . Fills the`value`on success.
_decimal ToDecimal(decimal defaultValue)_	Attempts to get this value as a [System.Decimal](https://docs.microsoft.com/en-us/dotnet/api/system.decimal?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.decimal?view=netframework-4.6) . Fills the`value`on success.
_void GetLines(List lines)_	Retrieves each individual line of this value into the provided list.
_string ToString()_	Attempts to get this value as a [System.String](https://docs.microsoft.com/en-us/dotnet/api/system.string?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.string?view=netframework-4.6) . 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](https://docs.microsoft.com/en-us/dotnet/api/system.string?view=netframework-4.6) . Fills the`value`on success.
_void Write(StringBuilder stringBuilder)_	Writes this value as a string to the given string builder.