NetworkFolders

Type 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

Members

Properties

Property	Type	Summary
Count	int	Gets the number of NetworkFolders contained in the collection.
this[]	ISIAPINetworkFolder	Get the NetworkFolder from the collection by the NetworkFolder name.
this[]	ISIAPINetworkFolder	Get the NetworkFolder at the specified index.

Methods

Method	Returns	Summary
NetworkFolderExists(string)	bool	Queries whether a particular NetworkFolder exists in the collection

Properties

Count

Gets the number of NetworkFolders contained in the collection.

int Count { get; }

Type int

Code samples

C#C++PythonPowerShell

int count = networkFolders.Count;

long count;
networkFolders->get_Count(&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

C#C++PythonPowerShell

var this[] = networkFolders.this[];

CComPtr<ISIAPINetworkFolder> this[];
networkFolders->get_this[](&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

C#C++PythonPowerShell

var this[] = networkFolders.this[];

CComPtr<ISIAPINetworkFolder> this[];
networkFolders->get_this[](&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

C#C++PythonPowerShell

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

VARIANT_BOOL result;
networkFolders->NetworkFolderExists(CComBSTR(L"Example"), &result);

result = networkFolders.NetworkFolderExists(r"Example")

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