Class Config

Represents a TileDB config object.

Inheritance
object
Config
Implements
Namespace: TileDB.CSharp
Assembly: TileDB.CSharp.dll
Syntax
public sealed class Config : IDisposable, IEnumerable<KeyValuePair<string, string>>, IEnumerable

Constructors

| Edit this page View Source

Config()

Creates a Config.

Declaration
public Config()

Methods

| Edit this page View Source

Cmp(ref Config)

Checks if two Configs have the same content.

Declaration
public bool Cmp(ref Config other)
Parameters
Type Name Description
Config other

The config to compare this one with.
Returns
Type Description
bool
| Edit this page View Source

Dispose()

Disposes this Config.

Declaration
public void Dispose()
| Edit this page View Source

EnumerateOptions(string)

Enumerates the config's options that start with a specific prefix.

Declaration
public IEnumerable<KeyValuePair<string, string>> EnumerateOptions(string prefix)
Parameters
Type Name Description
string prefix

The prefix of the options to enumerate.
Returns
Type Description
IEnumerable<KeyValuePair<string, string>>
| Edit this page View Source

Get(string)

Gets the value of a parameter.

Declaration
public string Get(string param)
Parameters
Type Name Description
string param

The parameter's name
Returns
Type Description
string
Exceptions
Type Condition
ArgumentException

param is null or empty.
| Edit this page View Source

GetEnumerator()

Enumerates the config's options.

Declaration
public IEnumerator<KeyValuePair<string, string>> GetEnumerator()
Returns
Type Description
IEnumerator<KeyValuePair<string, string>>
| Edit this page View Source

Iterate(string)

Gets a ConfigIterator that enumerates over all options whose parameter namess start with a given prefix.

Declaration
public ConfigIterator Iterate(string prefix)
Parameters
Type Name Description
string prefix

The parameters' name's prefix.
Returns
Type Description
ConfigIterator
| Edit this page View Source

LoadFromFile(string)

Loads the options from a file.

Declaration
public void LoadFromFile(string filename)
Parameters
Type Name Description
string filename

The file's name.
Exceptions
Type Condition
ArgumentException

filename is null or empty.
| Edit this page View Source

SaveToFile(string)

Saves the options from a file.

Declaration
public void SaveToFile(string filename)
Parameters
Type Name Description
string filename

The file's name.
Exceptions
Type Condition
ArgumentException

filename is null or empty.
| Edit this page View Source

Set(string, string)

Sets a parameter.

Declaration
public void Set(string param, string value)
Parameters
Type Name Description
string param

The parameter's name.
string value

The parameter's value.
Exceptions
Type Condition
ArgumentException

param is null or empty.
| Edit this page View Source

Unset(string)

Unsets a parameter.

Declaration
public void Unset(string param)
Parameters
Type Name Description
string param

The parameter's name.
Exceptions
Type Condition
ArgumentException

param is null or empty.

Implements