Class ErcCore

A single instance of this object should be instantiated at a minimum. It is used for storing global variables such as the working directory etc.

Inheritance

System.Object

ErcCore

ErcResult<T>

ProcessInfo

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: ERC

Assembly: ERC.Net.dll

Syntax

public class ErcCore

Constructors

ErcCore()

Constructor.

Declaration

public ErcCore()

ErcCore(ErcCore)

Constructor to be used when creating an object that inherits from an ErcCore object.

Declaration

protected ErcCore(ErcCore parent)

Parameters

Type	Name	Description
ErcCore	parent	The ErcCore object to be inherited from.

Properties

Author

The Author to be credited in output files.

Declaration

public string Author { get; set; }

Property Value

Type	Description
System.String

ErcVersion

The current version of the ERC.Net library

Declaration

public string ErcVersion { get; }

Property Value

Type	Description
System.String

PatternExtendedPath

Path to the file containing the extended pattern to be used.

Declaration

public string PatternExtendedPath { get; set; }

Property Value

Type	Description
System.String

PatternStandardPath

Path to the file containing the standard pattern to be used.

Declaration

public string PatternStandardPath { get; set; }

Property Value

Type	Description
System.String

SystemErrorLogPath

Path where error details should be logged.

Declaration

public string SystemErrorLogPath { get; set; }

Property Value

Type	Description
System.String

WorkingDirectory

The directory where output files will be saved.

Declaration

public string WorkingDirectory { get; }

Property Value

Type	Description
System.String

Methods

GetHandleInformation(IntPtr, out UInt32)

Retrieves certain properties of an object handle.

Declaration

public static bool GetHandleInformation(IntPtr hObject, out uint lpdwFlags)

Parameters

Type	Name	Description
System.IntPtr	hObject	A handle to an object whose information is to be retrieved.
System.UInt32	lpdwFlags	A pointer to a variable that receives a set of bit flags that specify properties of the object handle or 0. The following values are defined.

Returns

Type	Description
System.Boolean	If the function succeeds, the return value is true.

LogEvent(Exception)

Logs events to the error log path in the XML file. This file is only appended to and never replaced.

Declaration

public void LogEvent(Exception e)

Parameters

Type	Name	Description
System.Exception	e	The exception to log

SetAuthor(String)

Sets the name of the author for use when outputing results to disk.

Declaration

public void SetAuthor(string author)

Parameters

Type	Name	Description
System.String	author	String containing the name of the author

SetErrorFile(String)

Sets the error log file to a user specified filepath.

Declaration

public void SetErrorFile(string path)

Parameters

Type	Name	Description
System.String	path	The new error log filepath.

SetPatternExtendedPath(String)

Sets the extended pattern file path. Any pattern can replace the extended pattern when searching however the new pattern must be written to a file and the file path set here.

Declaration

public void SetPatternExtendedPath(string path)

Parameters

Type	Name	Description
System.String	path	The filepath of the new extended pattern file

SetPatternStandardPath(String)

Sets the standard pattern file path. Any pattern can replace the standard pattern when searching however the new pattern must be written to a file and the file path set here.

Declaration

public void SetPatternStandardPath(string path)

Parameters

Type	Name	Description
System.String	path	The filepath of the new standard pattern file

SetWorkingDirectory(String)

Changes the working directory in both the XML file and associated ErcCore object

Declaration

public void SetWorkingDirectory(string path)

Parameters

Type	Name	Description
System.String	path