Class SqlServerConnectionResolution

Namespace

ItTiger.TigerQuery.Core

Assembly

ItTiger.TigerQuery.Core.dll

Outcome of resolving a saved connection profile (by name) to a usable SQL Server connection string. Either carries a non-empty ConnectionString on success, or an ErrorMessage describing why resolution failed.

public sealed class SqlServerConnectionResolution

Inheritance

object

SqlServerConnectionResolution

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ConnectionString

The resolved connection string. Non-null only when IsSuccess is true.

public string? ConnectionString { get; }

Property Value

string

ErrorMessage

A clean, user-facing failure reason. Non-null only when IsSuccess is false.

public string? ErrorMessage { get; }

Property Value

string

IsSuccess

Gets whether resolution produced a usable nonblank connection string.

public bool IsSuccess { get; }

Property Value

bool

Methods

Failure(string)

Creates a failed resolution with a user-facing reason.

public static SqlServerConnectionResolution Failure(string errorMessage)

Parameters

errorMessage string

The nonblank failure reason.

Returns

SqlServerConnectionResolution

A failure carrying errorMessage.

Exceptions

ArgumentException

errorMessage is null, empty, or whitespace. The parameter name is errorMessage.

Success(string)

Creates a successful resolution.

public static SqlServerConnectionResolution Success(string connectionString)

Parameters

connectionString string

The nonblank resolved connection string.

Returns

SqlServerConnectionResolution

A success carrying connectionString.

Exceptions

ArgumentException

connectionString is null, empty, or whitespace. The parameter name is connectionString.