Skip to content

ISIAPISiteFolders Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 422C915D-C65C-4E49-BE6A-9F77C6E031BE

SiteFolder collection wrapper interface

Declaration

[Guid("422C915D-C65C-4E49-BE6A-9F77C6E031BE")]
public interface ISIAPISiteFolders

Get an instance

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

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

# Navigate to the ISIAPISiteFolders you need via the ISIAPI tree.
# See ISIAPI for the activation root.
siteFolders = ...

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

Properties

Count

Gets the number of SiteFolders contained in the collection.

int Count { get; }

Type int

Code samples 
int count = siteFolders.Count;

Dim count As Integer = siteFolders.Count

count = siteFolders.Count

$count = $siteFolders.Count

this[]

Get the SiteFolder from the collection by the SiteFolder name.

ISIAPISiteFolder this[] { get; }

Type ISIAPISiteFolder

Remarks

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

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

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

Dim this[] As ISIAPISiteFolder = siteFolders.this[]

this[] = siteFolders.this[]

$this[] = $siteFolders.this[]

this[]

Get the SiteFolder at the specified index.

ISIAPISiteFolder this[] { get; }

Type ISIAPISiteFolder

Remarks

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

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

Dim this[] As ISIAPISiteFolder = siteFolders.this[]

this[] = siteFolders.this[]

$this[] = $siteFolders.this[]

Methods

SiteFolderExists(string)

Queries whether a particular SiteFolder exists in the collection

bool SiteFolderExists(string name)

Parameters

Name Type Description
name string SiteFolder name to query

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

Remarks

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

Code samples 
bool result = siteFolders.SiteFolderExists(@"Example");

Dim result As Boolean = siteFolders.SiteFolderExists("Example")

result = siteFolders.SiteFolderExists(r"Example")

$result = $siteFolders.SiteFolderExists("Example")