Class ProgramUtility

Namespace

Songhay

Assembly

SonghayCore.dll

Defines shared routines for Studio programs.

public static class ProgramUtility

Inheritance

object

ProgramUtility

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetConsoleCharacters(string?)

Gets the console characters.

public static string? GetConsoleCharacters(string? input)

Parameters

input string

The input.

Returns

string

Returns formatted input.

GetConsoleIndentation(int, int)

Gets the indentation spaces for test display.

public static string GetConsoleIndentation(int numberOfSpaces, int indentationLevel)

Parameters

numberOfSpaces int

indentationLevel int

Returns

string

GetCurrentMethodName()

Gets the name of the current method.

public static string? GetCurrentMethodName()

Returns

string

GetMethodName(int)

Gets the name of the current method.

public static string? GetMethodName(int stackFrameIndex)

Parameters

stackFrameIndex int

Index of the stack frame.

Returns

string

HandleDebug()

Pauses the shell Program in DEBUG mode.

public static void HandleDebug()

InitializeTraceSource(TraceListener?)

Initializes the trace source.

public static TraceSource? InitializeTraceSource(TraceListener? listener)

Parameters

listener TraceListener

The listener.

Returns

TraceSource

LoadConfiguration(string?)

Loads the configuration.

public static IConfigurationRoot LoadConfiguration(string? basePath)

Parameters

basePath string

The base path.

Returns

IConfigurationRoot

LoadConfiguration(string?, Func<IConfigurationBuilder, IConfigurationBuilder>?, params string[])

Loads the built configuration.

public static IConfigurationRoot LoadConfiguration(string? basePath, Func<IConfigurationBuilder, IConfigurationBuilder>? builderModifier, params string[] requiredJsonConfigurationFiles)

Parameters

basePath string

The base path.

builderModifier Func<IConfigurationBuilder, IConfigurationBuilder>

Allows modification of ConfigurationBuilder before build.

requiredJsonConfigurationFiles string[]

specify any additional JSON configuration files before build

Returns

IConfigurationRoot

Returns the built configuration.

LoadConfiguration(string?, params string[])

Loads the built configuration.

public static IConfigurationRoot LoadConfiguration(string? basePath, params string[] requiredJsonConfigurationFiles)

Parameters

basePath string

The base path.

requiredJsonConfigurationFiles string[]

specify any additional JSON configuration files before build

Returns

IConfigurationRoot

Returns the built configuration.

StartProcess(string?)

Starts the process.

public static void StartProcess(string? command)

Parameters

command string

The command.

StartProcess(string, string, bool)

Starts the process.

public static void StartProcess(string argumentOfExe, string pathToExe, bool useExe)

Parameters

argumentOfExe string

The argument of executable.

pathToExe string

The path to executable.

useExe bool

if set to true use path to executable.