Table of Contents

Class IniFile

Namespace
ChartTools.IO.Ini
Assembly
ChartTools.dll

Provides methods for reading and writing ini files

public static class IniFile
Inheritance
IniFile
Inherited Members

Methods

ReadMetadata(ReadingDataSource, Metadata?)

Reads the Metadata from an ini target.

public static Metadata ReadMetadata(ReadingDataSource source, Metadata? existing = null)

Parameters

source ReadingDataSource

File path or stream to read from

existing Metadata

Metadata from another target to combine with

Returns

Metadata

Metadata object provided as the existing parameter, or a new instance if passed null.

ReadMetadataAsync(ReadingDataSource, Metadata?, CancellationToken)

Reads the Metadata from an ini target asynchronously.

public static Task<Metadata> ReadMetadataAsync(ReadingDataSource source, Metadata? existing = null, CancellationToken cancellationToken = default)

Parameters

source ReadingDataSource

File path or stream to read from

existing Metadata

Metadata from another target to combine with

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<Metadata>

Metadata object provided as the existing parameter, or a new instance if passed null.

WriteMetadata(WritingDataSource, Metadata)

Writes the Metadata to an ini target.

public static void WriteMetadata(WritingDataSource source, Metadata metadata)

Parameters

source WritingDataSource

File path or stream to write to

metadata Metadata

Metadata to write

WriteMetadataAsync(WritingDataSource, Metadata, CancellationToken)

Writes the Metadata to an ini target asynchronously.

public static Task WriteMetadataAsync(WritingDataSource source, Metadata metadata, CancellationToken cancellationToken = default)

Parameters

source WritingDataSource

File path or stream to write to

metadata Metadata

Metadata to write

cancellationToken CancellationToken

Token used for cancellation

Returns

Task