Class PvInterface

Represents one interface (network adapter or USB host controller) on a system (the PC)

Inheritance

object

PvInterface

PvNetworkAdapter

PvUSBHostController

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNet

Assembly: eBUSDotNet.dll

Syntax

public class PvInterface : IDisposable

Remarks

To use this class, see PvSystem.

Fields

swigCMemOwn

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

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

CompareID

Gets the comparison identifier used for interface sorting or matching.

Declaration

public string CompareID { get; }

Property Value

Type	Description
string

DeviceCount

Gets the number of devices detected on the interface.

Declaration

public uint DeviceCount { get; }

Property Value

Type	Description
uint

DisplayID

Gets the human-readable display ID for the interface.

Declaration

public string DisplayID { get; }

Property Value

Type	Description
string

Name

Gets the interface name.

Declaration

public string Name { get; }

Property Value

Type	Description
string

PleoraDriverVersion

Gets the Pleora driver version associated with the interface.

Declaration

public string PleoraDriverVersion { get; }

Property Value

Type	Description
string

Type

Gets the interface type (network adapter, USB host controller, etc.).

Declaration

public PvInterfaceType Type { get; }

Property Value

Type	Description
PvInterfaceType

UniqueID

Gets the unique identifier for the interface.

Declaration

public string UniqueID { get; }

Property Value

Type	Description
string

Methods

Compare(PvInterface, PvInterface)

Static method used for sorting interfaces

Declaration

public static bool Compare(PvInterface a1, PvInterface a2)

Parameters

Type	Name	Description
PvInterface	a1	A first interface.
PvInterface	a2	A second interface.

Returns

Type	Description
bool	true if the value of the first character that doesn't match is lower in a1's ID or all compared characters match but the compared ID is shorter. false otherwise.

Copy()

Creates a copy of the PvInterface object.

Declaration

public PvInterface Copy()

Returns

Type	Description
PvInterface	Pointer to the PvInterface copy. The user is reponsable to delete/free this pointer.

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~PvInterface()

Destructor.

Declaration

protected ~PvInterface()

GetDeviceInfo(uint)

Get information identifying a device.

Declaration

public PvDeviceInfo GetDeviceInfo(uint aIndex)

Parameters

Type	Name	Description
uint	aIndex	The device's array position. The zero-based parameter accepts 0 through #GetDeviceCount-1.

Returns

Type	Description
PvDeviceInfo	Information identifying a device; a #PvDeviceInfo object. If aIndex is out of bounds, the return is NULL.

GetType()

Get the interface type.

Declaration

public PvInterfaceType GetType()

Returns

Type	Description
PvInterfaceType	Type of interface (network interface or USB host controller). See #PvInterfaceType Enum.

Implements

IDisposable