Skip to content

ISIAPINetworkFolders Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: FD0AEE9A-9E4B-4E45-806B-5D808CCBCBE8

NetworkFolder collection wrapper interface

Declaration

[Guid("FD0AEE9A-9E4B-4E45-806B-5D808CCBCBE8")]
public interface ISIAPINetworkFolders

Get an instance

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

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

# Navigate to the ISIAPINetworkFolders you need via the ISIAPI tree.
# See ISIAPI for the activation root.
networkFolders = ...

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

Properties

Count

Gets the number of NetworkFolders contained in the collection.

int Count { get; }

Type int

Code samples 
int count = networkFolders.Count;

Dim count As Integer = networkFolders.Count

count = networkFolders.Count

$count = $networkFolders.Count

this[]

Get the NetworkFolder from the collection by the NetworkFolder name.

ISIAPINetworkFolder this[] { get; }

Type ISIAPINetworkFolder

Remarks

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

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

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

Dim this[] As ISIAPINetworkFolder = networkFolders.this[]

this[] = networkFolders.this[]

$this[] = $networkFolders.this[]

this[]

Get the NetworkFolder at the specified index.

ISIAPINetworkFolder this[] { get; }

Type ISIAPINetworkFolder

Remarks

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

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

Dim this[] As ISIAPINetworkFolder = networkFolders.this[]

this[] = networkFolders.this[]

$this[] = $networkFolders.this[]

Methods

NetworkFolderExists(string)

Queries whether a particular NetworkFolder exists in the collection

bool NetworkFolderExists(string name)

Parameters

Name Type Description
name string NetworkFolder name to query

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

Remarks

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

Code samples 
bool result = networkFolders.NetworkFolderExists(@"Example");

Dim result As Boolean = networkFolders.NetworkFolderExists("Example")

result = networkFolders.NetworkFolderExists(r"Example")

$result = $networkFolders.NetworkFolderExists("Example")