C# Класс SteamKit2.KeyValue

Represents a recursive string key to arbitrary value container.

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
Invalid	KeyValue

Открытые методы

Метод	Описание
AsBoolean ( bool defaultValue = default(bool) ) : bool	Attempts to convert and return the value of this instance as a boolean. If the conversion is invalid, the default value is returned.
AsFloat ( float defaultValue = default(float) ) : float	Attempts to convert and return the value of this instance as a float. If the conversion is invalid, the default value is returned.
AsInteger ( int defaultValue = default(int) ) : int	Attempts to convert and return the value of this instance as an integer. If the conversion is invalid, the default value is returned.
AsLong ( long defaultValue = default(long) ) : long	Attempts to convert and return the value of this instance as a long. If the conversion is invalid, the default value is returned.
AsString ( ) : string	Returns the value of this instance as a string.
KeyValue ( string name = null, string value = null ) : System	Initializes a new instance of the KeyValue class.
LoadAsBinary ( string path ) : KeyValue	Attempts to load the given filename as a binary KeyValue. This method will swallow any exceptions that occur when reading, use ReadAsBinary if you wish to handle exceptions.
LoadAsText ( string path ) : KeyValue	Attempts to load the given filename as a text KeyValue. This method will swallow any exceptions that occur when reading, use ReadAsText if you wish to handle exceptions.
LoadFromString ( string input ) : KeyValue	Attempts to create an instance of KeyValue from the given input text. This method will swallow any exceptions that occur when reading, use ReadAsText if you wish to handle exceptions.
ReadAsBinary ( Stream input ) : bool	Populate this instance from the given Stream as a binary KeyValue.
ReadAsText ( Stream input ) : bool	Populate this instance from the given Stream as a text KeyValue.
ReadFileAsText ( string filename ) : bool	Opens and reads the given filename as text.
SaveToFile ( string path, bool asBinary ) : void	Saves this instance to file.
ToString ( ) : string	Returns a System.String that represents this instance.
this ( string key ) : KeyValue	Gets the child SteamKit2.KeyValue with the specified key. If no child with this key exists, Invalid is returned.

Приватные методы

Метод	Описание
LoadFromFile ( string path, bool asBinary ) : KeyValue
RecursiveLoadFromBuffer ( KVTextReader kvr ) : void
RecursiveSaveToFile ( FileStream f ) : void
RecursiveSaveToFile ( FileStream f, int indentLevel ) : void
WriteIndents ( FileStream f, int indentLevel ) : void
WriteString ( FileStream f, string str, bool quote = false ) : void

Описание методов

AsBoolean() публичный Метод

Attempts to convert and return the value of this instance as a boolean. If the conversion is invalid, the default value is returned.

public AsBoolean ( bool defaultValue = default(bool) ) : bool
defaultValue	bool	The default value to return if the conversion is invalid.
Результат	bool

AsFloat() публичный Метод

Attempts to convert and return the value of this instance as a float. If the conversion is invalid, the default value is returned.

public AsFloat ( float defaultValue = default(float) ) : float
defaultValue	float	The default value to return if the conversion is invalid.
Результат	float

AsInteger() публичный Метод

Attempts to convert and return the value of this instance as an integer. If the conversion is invalid, the default value is returned.

public AsInteger ( int defaultValue = default(int) ) : int
defaultValue	int	The default value to return if the conversion is invalid.
Результат	int

AsLong() публичный Метод

Attempts to convert and return the value of this instance as a long. If the conversion is invalid, the default value is returned.

public AsLong ( long defaultValue = default(long) ) : long
defaultValue	long	The default value to return if the conversion is invalid.
Результат	long

AsString() публичный Метод

Returns the value of this instance as a string.

public AsString ( ) : string
Результат	string

KeyValue() публичный Метод

Initializes a new instance of the KeyValue class.

public KeyValue ( string name = null, string value = null ) : System
name	string	The optional name of the root key.
value	string	The optional value assigned to the root key.
Результат	System

LoadAsBinary() публичный статический Метод

Attempts to load the given filename as a binary KeyValue.

This method will swallow any exceptions that occur when reading, use ReadAsBinary if you wish to handle exceptions.

public static LoadAsBinary ( string path ) : KeyValue
path	string	The path to the file to load.
Результат	KeyValue

LoadAsText() публичный статический Метод

Attempts to load the given filename as a text KeyValue.

This method will swallow any exceptions that occur when reading, use ReadAsText if you wish to handle exceptions.

public static LoadAsText ( string path ) : KeyValue
path	string	The path to the file to load.
Результат	KeyValue

LoadFromString() публичный статический Метод

Attempts to create an instance of KeyValue from the given input text.

This method will swallow any exceptions that occur when reading, use ReadAsText if you wish to handle exceptions.

public static LoadFromString ( string input ) : KeyValue
input	string	The input text to load.
Результат	KeyValue

ReadAsBinary() публичный Метод

Populate this instance from the given Stream as a binary KeyValue.

public ReadAsBinary ( Stream input ) : bool
input	Stream	The input to read from.
Результат	bool

ReadAsText() публичный Метод

Populate this instance from the given Stream as a text KeyValue.

public ReadAsText ( Stream input ) : bool
input	Stream	The input to read from.
Результат	bool

ReadFileAsText() публичный Метод

Opens and reads the given filename as text.

public ReadFileAsText ( string filename ) : bool
filename	string	The file to open and read.
Результат	bool

SaveToFile() публичный Метод

Saves this instance to file.

public SaveToFile ( string path, bool asBinary ) : void
path	string	The file path to save to.
asBinary	bool	If set to true, saves this instance as binary.
Результат	void

ToString() публичный Метод

Returns a System.String that represents this instance.

public ToString ( ) : string
Результат	string

this() публичный Метод

Gets the child SteamKit2.KeyValue with the specified key. If no child with this key exists, Invalid is returned.

public this ( string key ) : KeyValue
key	string
Результат	KeyValue

Описание свойств

Invalid публичное статическое свойство

Represents an invalid KeyValue given when a searched for child does not exist.

public static KeyValue,SteamKit2 Invalid
Результат	KeyValue