Table of Contents

Class Environment.Enumerator

Namespace
Sdl3Sharp.Utilities
Assembly
Sdl3Sharp.dll

Enumerates the environment variables in a set of environment variables

public sealed class Environment.Enumerator : IEnumerator<KeyValuePair<string, string>>, IEnumerator, IDisposable
Inheritance
Environment.Enumerator
Implements
Inherited Members

Properties

Current

Gets the element in the collection at the current position of the enumerator.

public KeyValuePair<string, string> Current { get; }

Property Value

KeyValuePair<string, string>

The element in the collection at the current position of the enumerator.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

MoveNext()

Advances the enumerator to the next element of the collection.

public bool MoveNext()

Returns

bool

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.

Reset()

Sets the enumerator to its initial position, which is before the first element in the collection.

public void Reset()

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.

NotSupportedException

The enumerator does not support being reset.

TryCreate(Environment, out Enumerator)

public static bool TryCreate(Environment environment, out Environment.Enumerator enumerator)

Parameters

environment Environment

The set of environment variables to enumerate

enumerator Environment.Enumerator

The newly created enumerator for the set of environment variables, when this mehtod returns true; otherwise, null

Returns

bool

true if a new Environment.Enumerator was successfully created for the set of environment variables; otherwise, false (check TryGet(out string?) for more information)

Exceptions

ArgumentNullException

environment is null

ObjectDisposedException

environment was already disposed