Table of Contents

Class EnvironmentVariable

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents an individual environment variable found on a Windows based computer system.

public class EnvironmentVariable : GlobalSerializableClassicBase, IComparable<EnvironmentVariable>
Inheritance
EnvironmentVariable
Implements

Constructors

EnvironmentVariable()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.EnvironmentVariable class.

public EnvironmentVariable()

Properties

DisplayName

Gets the unique ID for this environment variable in the format "%NAME%" for system variables or "%NAME% [Username]" for user variables.

public string DisplayName { get; }

Property Value

string

IsSystemVariable

Gets or sets whether this is a system variable.

public BooleanOption IsSystemVariable { get; set; }

Property Value

BooleanOption

UserName

Gets or sets the name of the user to which this environment variable belongs in the format "domain\user" or "SYSTEM" for system variables.

public string UserName { get; set; }

Property Value

string

Value

Gets or sets the value of the environment variable at the time of the scan.

public string Value { get; set; }

Property Value

string

VariableName

Gets or sets the name of the environment variable - for example "%PATH%".

public string VariableName { get; set; }

Property Value

string

Remarks

The name is always formatted enclosed in percentage signs.

Methods

CompareTo(EnvironmentVariable)

Compares two CENTREL.XIA.Configuration.Types.EnvironmentVariable objects to allow sorting by display name.

public int CompareTo(EnvironmentVariable other)

Parameters

other EnvironmentVariable

The CENTREL.XIA.Configuration.Types.EnvironmentVariable to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.EnvironmentVariable objects.

ToString()

Returns the unique ID for this environment variable in the format "%NAME%" for system variables or "%NAME% [Username]" for user variables.

public override string ToString()

Returns

string

The unique ID for this environment variable.