Show / Hide Table of Contents

Class MyIniParseResult

Represents the results of a configuration parsing.

Inheritance
System.Object
MyIniParseResult
Namespace: VRage.Game.ModAPI.Ingame.Utilities
Assembly: VRage.Game.dll
Syntax
public sealed class MyIniParseResult : ValueType

Fields

Error

Gets a description of the error that occurred during parsing. Will be null if no error occurred.

Declaration
public readonly string Error
Field Value
Type Description
System.String

Properties

IsDefined

Determines if the value of this result is defined, meaning whether the Success actually holds any meaning.

Declaration
public bool IsDefined { get; }
Property Value
Type Description
System.Boolean

LineNo

Gets the line number where an error occured.

Declaration
public int LineNo { get; }
Property Value
Type Description
System.Int32

Success

Determines the success of the configuration parsing.

Declaration
public bool Success { get; }
Property Value
Type Description
System.Boolean

Methods

Equals(Object)

Compares this MyIniParseResult with another.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

Equals(MyIniParseResult)

Compares this MyIniParseResult with another.

Declaration
public bool Equals(MyIniParseResult other)
Parameters
Type Name Description
MyIniParseResult other
Returns
Type Description
System.Boolean

GetHashCode()

Gets the hash code for this MyIniParseResult.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

ToString()

Generates a generic error message in the form of Line N: Error

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

Equality(MyIniParseResult, MyIniParseResult)

Compares the two MyIniParseResults.

Declaration
public static bool operator ==(MyIniParseResult a, MyIniParseResult b)
Parameters
Type Name Description
MyIniParseResult a
MyIniParseResult b
Returns
Type Description
System.Boolean

Inequality(MyIniParseResult, MyIniParseResult)

Compares the two MyIniParseResults.

Declaration
public static bool operator !=(MyIniParseResult a, MyIniParseResult b)
Parameters
Type Name Description
MyIniParseResult a
MyIniParseResult b
Returns
Type Description
System.Boolean
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾