CVB.Net 14.0
DiscoveryInformationList Class Reference

Contains all results from a discovery run. More...

Inherits IList< DiscoveryInformation >, and INativeHandle.

Public Member Functions

void Dispose ()
 Disposes this information list.
 
void Add (DiscoveryInformation item)
 Not supported. More...
 
void Clear ()
 Not supported. More...
 
bool Contains (DiscoveryInformation item)
 Checks whether the given item is inside this list. More...
 
void CopyTo (DiscoveryInformation[] array, int arrayIndex)
 Copies the elements of this collection to an array , starting at a particular arrayIndex . More...
 
int IndexOf (DiscoveryInformation item)
 Gets the index of the given item . More...
 
void Insert (int index, DiscoveryInformation item)
 Not supported. More...
 
bool Remove (DiscoveryInformation item)
 Not supported. More...
 
void RemoveAt (int index)
 Not supported. More...
 
IEnumerator< DiscoveryInformationGetEnumerator ()
 Gets the typed enumerator for this list. More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 Actual dispose implementation. More...
 

Properties

IntPtr Handle [get]
 Gets the native object handle of the discovery information list.
 
bool IsDisposed [get]
 Gets whether this object has been disposed.
 
DiscoveryInformation this[int index] [get, set]
 Get the entry with the given index . More...
 
int Count [get]
 Gets the number of discovered devices/nodes.
 
bool IsReadOnly [get]
 Always returns true as this is a read only collection.
 
- Properties inherited from INativeHandle
IntPtr Handle [get]
 The native handle of the object.
 
bool IsDisposed [get]
 Possibility to check whether the object has already been disposed of.
 

Events

NativeHandleEventDelegate ObjectDisposing
 Event that is fired when this object is about to be disposed.
 
- Events inherited from INativeHandle
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
More...
 

Detailed Description

Contains all results from a discovery run.

Member Function Documentation

◆ Add()

void Add ( DiscoveryInformation  item)

Not supported.

Parameters
itemIgnored.
Exceptions
NotSupportedExceptionThis collection is read only.

◆ Clear()

void Clear ( )

Not supported.

Exceptions
NotSupportedExceptionThis collection is read only.

◆ Contains()

bool Contains ( DiscoveryInformation  item)

Checks whether the given item is inside this list.

Parameters
itemItem to check.
Returns
true if item is inside this list; false otherwise.

◆ CopyTo()

void CopyTo ( DiscoveryInformation[]  array,
int  arrayIndex 
)

Copies the elements of this collection to an array , starting at a particular arrayIndex .

Parameters
arrayOne-dimensional array that is the destination of the elements copied from this collection. The array must have zero-based indexing.
arrayIndexZero-based index in array at which copying begins.
Exceptions
ArgumentNullExceptionarray is null.
ArgumentOutOfRangeExceptionarrayIndex is less than 0.
ArgumentExceptionThe number of elements in this collection is greater than the available space from arrayIndex to the end of the destination array .

◆ Dispose()

virtual void Dispose ( bool  disposing)
protectedvirtual

Actual dispose implementation.

Parameters
disposingtrue if called from IDisposable.Dispose; false if called from finalizer.

◆ GetEnumerator()

IEnumerator< DiscoveryInformation > GetEnumerator ( )

Gets the typed enumerator for this list.

Returns
Enumerator enumerating all elements in this list.

◆ IndexOf()

int IndexOf ( DiscoveryInformation  item)

Gets the index of the given item .

Parameters
itemThe item to get the index for.
Returns
Index of the given item ; -1 if not inside this list.

◆ Insert()

void Insert ( int  index,
DiscoveryInformation  item 
)

Not supported.

Parameters
indexIgnored.
itemIgnored.
Exceptions
NotSupportedExceptionThis collection is read only.

◆ Remove()

bool Remove ( DiscoveryInformation  item)

Not supported.

Parameters
itemIgnored.
Returns
Nothing.
Exceptions
NotSupportedExceptionThis collection is read only.

◆ RemoveAt()

void RemoveAt ( int  index)

Not supported.

Parameters
indexIgnored.
Exceptions
NotSupportedExceptionThis collection is read only.

Property Documentation

◆ this[int index]

DiscoveryInformation this[int index]
getset

Get the entry with the given index .

Parameters
indexEntry index to get.
Returns
The entry at the given index .
Exceptions
ArgumentOutOfRangeExceptionIf index is outside of range.
NotSupportedExceptionSet is not supported.