Class PvResult

Result information.

Inheritance

object

PvResult

Implements

IDisposable

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNet

Assembly: eBUSDotNet.dll

Syntax

public class PvResult : IDisposable

Constructors

PvResult()

Constructor.

Declaration

public PvResult()

PvResult(PvResult)

Copy constructor.

Declaration

public PvResult(PvResult aResult)

Parameters

Type	Name	Description
PvResult	aResult	PvResult used to call the copy constructor.

PvResult(uint)

Constructor intializing the object to a specific status code.

Declaration

public PvResult(uint aCode)

Parameters

Type	Name	Description
uint	aCode	Code to assign to the #PvResult object on construction.

PvResult(uint, string)

Constructor initializing the object to a specific status code and description.

Declaration

public PvResult(uint aCode, string aDescription)

Parameters

Type	Name	Description
uint	aCode	Code to assign to the #PvResult object on construction.
string	aDescription	Description to assign to the #PvResult object on construction.

PvResult(uint, uint)

Constructor intializing the object to a specific status code and OS code.

Declaration

public PvResult(uint aCode, uint aOSCode)

Parameters

Type	Name	Description
uint	aCode	Code to assign to the #PvResult object on construction.
uint	aOSCode	OS code to assign to the #PvResult object on construction.

PvResult(uint, uint, string)

Constructor initializing the object to a specific status code, OS code and description.

Declaration

public PvResult(uint aCode, uint aOSCode, string aDescription)

Parameters

Type	Name	Description
uint	aCode	Code to assign to the #PvResult object on construction.
uint	aOSCode	OS code to assign to the #PvResult object on construction.
string	aDescription	Description to assign to the #PvResult object on construction.

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

CodeString

Gets the result code as a string.

Declaration

public string CodeString { get; }

Property Value

Type	Description
string

Description

Gets or sets the result description.

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

HasDescription

Gets whether the result has a description set.

Declaration

public bool HasDescription { get; }

Property Value

Type	Description
bool

InternalCode

Gets the internal result code.

Declaration

public uint InternalCode { get; }

Property Value

Type	Description
uint

IsFailure

Gets whether the result indicates a failure.

Declaration

public bool IsFailure { get; }

Property Value

Type	Description
bool

IsOK

Gets whether the result indicates immediate success (PV_OK).

Declaration

public bool IsOK { get; }

Property Value

Type	Description
bool

IsPending

Gets whether the result indicates a pending operation.

Declaration

public bool IsPending { get; }

Property Value

Type	Description
bool

IsSuccess

Gets whether the result indicates success (either OK or pending).

Declaration

public bool IsSuccess { get; }

Property Value

Type	Description
bool

OSCode

Gets the operating system specific error code.

Declaration

public uint OSCode { get; }

Property Value

Type	Description
uint

PvCode

Gets or sets the result code.

Declaration

public uint PvCode { get; set; }

Property Value

Type	Description
uint

Methods

Assign(PvResult)

Assigns the value from another PvResult.

Declaration

public PvResult Assign(PvResult aB)

Parameters

Type	Name	Description
PvResult	aB	The PvResult to copy from.

Returns

Type	Description
PvResult	Reference to this PvResult.

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Equals(object)

Determines whether the specified object is equal to this PvResult.

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
object	o	The object to compare with this instance.

Returns

Type	Description
bool	True if the specified object is equal to this PvResult, false otherwise.

Overrides

object.Equals(object)

~PvResult()

Destructor.

Declaration

protected ~PvResult()

GetHashCode()

Returns a hash code for this PvResult.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code based on the result code.

Overrides

object.GetHashCode()

Operators

operator |(PvResult, PvResult)

Combines two PvResult values using bitwise OR.

Declaration

public static PvResult operator |(PvResult a, PvResult b)

Parameters

Type	Name	Description
PvResult	a	The first PvResult.
PvResult	b	The second PvResult.

Returns

Type	Description
PvResult	A new PvResult with combined error codes.

operator ==(PvResult, object)

Compares a PvResult with another object for equality.

Declaration

public static bool operator ==(PvResult a, object b)

Parameters

Type	Name	Description
PvResult	a	The PvResult to compare.
object	b	The object to compare with (can be PvResult or uint).

Returns

Type	Description
bool	True if equal, false otherwise.

operator !=(PvResult, object)

Compares a PvResult with another object for inequality.

Declaration

public static bool operator !=(PvResult a, object b)

Parameters

Type	Name	Description
PvResult	a	The PvResult to compare.
object	b	The object to compare with (can be PvResult or uint).

Returns

Type	Description
bool	True if not equal, false otherwise.

Implements

IDisposable