VisionBox .NET Library
VIB_NET::SystemInfo Class Reference

Detailed Description

Collects information about a specific system type

This object is returned by VIBSystem::GetSystemInfo().

Public Member Functions

int CompareTo (VIB_NET::SystemInfo ^ otherSystem)
 Compares two instances of SystemInfo. More...
 
Boolean Equals (VIB_NET::SystemInfo ^ otherSystem)
 Test two instances of SystemInfo on equality. More...
 
 SystemInfo (SystemInfo ^ Obj)
 Creates an copy of a SystemInfo. More...
 
 SystemInfo (VIB_NET::eSYSTEM_TYPE Type, UInt32 Number)
 Creates an instance of SystemInfo. More...
 

Properties

UInt32 NumberOfEntities [get]
 Contains the number of installed entities for the system type represented by the object More...
 
VIB_NET::eSYSTEM_TYPE Type [get]
 Return the system type. More...
 

Constructor & Destructor Documentation

◆ SystemInfo() [1/2]

VIB_NET::SystemInfo::SystemInfo ( VIB_NET::eSYSTEM_TYPE  Type,
UInt32  Number 
)

Creates an instance of SystemInfo.

Parameters
TypeType of system.
NumberNumber of entities of the system.

◆ SystemInfo() [2/2]

VIB_NET::SystemInfo::SystemInfo ( SystemInfo Obj)

Creates an copy of a SystemInfo.

Parameters
ObjInstance to copy.


Member Function Documentation

◆ CompareTo()

int VIB_NET::SystemInfo::CompareTo ( VIB_NET::SystemInfo otherSystem)

Compares two instances of SystemInfo.

Parameters
otherSystemAnother instance of SystemInfo
Returns
0: types of both instances are equal.
-1: type of the main instance is lower than the type of the other instance.
1: type of the main instance is higher than the type of the other instance.

◆ Equals()

Boolean VIB_NET::SystemInfo::Equals ( VIB_NET::SystemInfo otherSystem)

Test two instances of SystemInfo on equality.

Parameters
otherSystemAnother instance of SystemInfo
Returns
true: types of both instances are equal.
false: types of both instances are different.

Property Documentation

◆ NumberOfEntities

VIB_NET::SystemInfo::NumberOfEntities
get

Contains the number of installed entities for the system type represented by the object

Note
USB hardware can be unplugged after the PC has started, but the library holds the system index constant. For this reason, the returned number can contain unavailable devices.

◆ Type

VIB_NET::SystemInfo::Type
get

Return the system type.

Returns
Type of system.