Skip to content

ISIAPINetworks Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: B2DE2D3C-39F6-4587-85FC-E2827F9C5A05

Network collection wrapper interface

Declaration

[Guid("B2DE2D3C-39F6-4587-85FC-E2827F9C5A05")]
public interface ISIAPINetworks

Get an instance

// Navigate to the ISIAPINetworks you need via the ISIAPI tree.
// See ISIAPI for the activation root.
var networks = /* ... */;

' Navigate to the ISIAPINetworks you need via the ISIAPI tree.
' See ISIAPI for the activation root.
Dim networks As ISIAPINetworks = Nothing

# Navigate to the ISIAPINetworks you need via the ISIAPI tree.
# See ISIAPI for the activation root.
networks = ...

# Navigate to the ISIAPINetworks you need via the ISIAPI tree.
# See ISIAPI for the activation root.
$networks = $null

Properties

Count

Gets the number of Networks contained in the collection.

int Count { get; }

Type int

Code samples 
int count = networks.Count;

Dim count As Integer = networks.Count

count = networks.Count

$count = $networks.Count

this[]

Get the Network from the collection by the Network name.

ISIAPINetwork this[] { get; }

Type ISIAPINetwork

Remarks

The Network name is not unique in the collection. It is possible that more than one Network has the same name. The first Network found by name is returned. If no Network is found, null / Nothing is returned.

In C#, use ISIAPINetworks[] to get a Network by its name or its position in the collection.
In VBA, use Item() to get a Network by its name or use Item_2() to get by its position.
In C++, use get_Item() to get a Network by its name or use get_Item_2() by its position.

Code samples 
var this[] = networks.this[];

Dim this[] As ISIAPINetwork = networks.this[]

this[] = networks.this[]

$this[] = $networks.this[]

this[]

Get the Network at the specified index.

ISIAPINetwork this[] { get; }

Type ISIAPINetwork

Remarks

In C#, use ISIAPINetworks[] to get a Network by its name or its position in the collection.
In VBA, use Item() to get a Network by its name or use Item_2() to get by its position.
In C++, use get_Item() to get a Network by its name or use get_Item_2() by its position.

Code samples 
var this[] = networks.this[];

Dim this[] As ISIAPINetwork = networks.this[]

this[] = networks.this[]

$this[] = $networks.this[]

Methods

NetworkExists(string)

Queries whether a particular Network exists in the collection

bool NetworkExists(string networkname)

Parameters

Name Type Description
networkname string Network name to query

Returns bool - True, if any Network with the given name exists in the collection. False otherwise

Remarks

The Network name is not unique in the collection. It is possible that more than one Network has the same name.

Code samples 
bool result = networks.NetworkExists(@"City Network");

Dim result As Boolean = networks.NetworkExists("City Network")

result = networks.NetworkExists(r"City Network")

$result = $networks.NetworkExists("City Network")

GetNetworkByID(string)

Get the Network by its GUID.

ISIAPINetwork GetNetworkByID(string network_id)

Parameters

Name Type Description
network_id string The GUID of the Network object, i.e. ISIAPINetwork.Network_id. This is different from the "Network ID" in the Network Data dialog, i.e. ISIAPINetwork.NetworkID.

Returns ISIAPINetwork

Code samples 
var result = networks.GetNetworkByID(@"id-1");

Dim result As ISIAPINetwork = networks.GetNetworkByID("id-1")

result = networks.GetNetworkByID(r"id-1")

$result = $networks.GetNetworkByID("id-1")