SiteFolders

Type 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

Members

Properties

Property	Type	Summary
Count	int	Gets the number of SiteFolders contained in the collection.
this[]	ISIAPISiteFolder	Get the SiteFolder from the collection by the SiteFolder name.
this[]	ISIAPISiteFolder	Get the SiteFolder at the specified index.

Methods

Method	Returns	Summary
SiteFolderExists(string)	bool	Queries whether a particular SiteFolder exists in the collection

Properties

Count

Gets the number of SiteFolders contained in the collection.

int Count { get; }

Type int

Code samples

C#C++PythonPowerShell

int count = siteFolders.Count;

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

C#C++PythonPowerShell

var this[] = siteFolders.this[];

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

C#C++PythonPowerShell

var this[] = siteFolders.this[];

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

C#C++PythonPowerShell

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

VARIANT_BOOL result;
siteFolders->SiteFolderExists(CComBSTR(L"Example"), &result);

result = siteFolders.SiteFolderExists(r"Example")

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