Skip to content

SiteScenarios

Type ISIAPISiteScenarios · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 88B31F79-E79E-4201-AE13-1D3C94EA14C5

Declaration

[Guid("88B31F79-E79E-4201-AE13-1D3C94EA14C5")]
public interface ISIAPISiteScenarios

Members

Properties

Property Type Summary
Count int Gets the number of SiteScenarios contained in the collection.
this[] ISIAPISiteScenario Get the SiteScenario from the collection by its name.
this[] ISIAPISiteScenario Get the SiteScenario at the specified index.

Methods

Method Returns Summary
SiteScenarioExists(string) bool Queries whether a particular SiteScenario exists in the collection by its name.

Properties

Count

Gets the number of SiteScenarios contained in the collection.

int Count { get; }

Type int

Code samples 
int count = siteScenarios.Count;

long count;
siteScenarios->get_Count(&count);

count = siteScenarios.Count

$count = $siteScenarios.Count

this[]

Get the SiteScenario from the collection by its name.

ISIAPISiteScenario this[] { get; }

Type ISIAPISiteScenario

Remarks

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

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

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

CComPtr<ISIAPISiteScenario> this[];
siteScenarios->get_this[](&this[]);

this[] = siteScenarios.this[]

$this[] = $siteScenarios.this[]

this[]

Get the SiteScenario at the specified index.

ISIAPISiteScenario this[] { get; }

Type ISIAPISiteScenario

Remarks

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

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

CComPtr<ISIAPISiteScenario> this[];
siteScenarios->get_this[](&this[]);

this[] = siteScenarios.this[]

$this[] = $siteScenarios.this[]

Methods

SiteScenarioExists(string)

Queries whether a particular SiteScenario exists in the collection by its name.

bool SiteScenarioExists(string siteScenarioName)

Parameters

Name Type Description
siteScenarioName string SiteScenario name to query

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

Remarks

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

Code samples 
bool result = siteScenarios.SiteScenarioExists(@"Example");

VARIANT_BOOL result;
siteScenarios->SiteScenarioExists(CComBSTR(L"Example"), &result);

result = siteScenarios.SiteScenarioExists(r"Example")

$result = $siteScenarios.SiteScenarioExists("Example")