AssignSchemeDemandScenarios

Type ISIAPIAssignSchemeDemandScenarios · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 392271DF-D6B1-4762-978E-768196E8ED37

AssignSchemeDemandScenario wrapper collection interface

Declaration

[Guid("392271DF-D6B1-4762-978E-768196E8ED37")]
public interface ISIAPIAssignSchemeDemandScenarios

Members

Properties

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

Methods

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

Properties

Count

Gets the number of AssignSchemeDemandScenarios contained in the collection.

int Count { get; }

Type int

Code samples

C#C++Python

int count = assignSchemeDemandScenarios.Count;

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

count = assignSchemeDemandScenarios.Count

this[]

Get the AssignSchemeDemandScenario from the collection by its name.

ISIAPIAssignSchemeDemandScenario this[] { get; }

Type ISIAPIAssignSchemeDemandScenario

Remarks

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

In C#, use ISIAPIAssignSchemeDemandScenarios[] to get an AssignSchemeDemandScenario by its name or its position in the collection.
In VBA, use Item() to get an AssignSchemeDemandScenario by its name or use Item_2() to get it by its position.
In C++, use get_Item() to get an AssignSchemeDemandScenario by its name or use get_Item_2() to get it by its position.

Code samples

C#C++Python

var this[] = assignSchemeDemandScenarios.this[];

CComPtr<ISIAPIAssignSchemeDemandScenario> this[];
assignSchemeDemandScenarios->get_this[](&this[]);

this[] = assignSchemeDemandScenarios.this[]

this[]

Get the AssignSchemeDemandScenario at the specified index.

ISIAPIAssignSchemeDemandScenario this[] { get; }

Type ISIAPIAssignSchemeDemandScenario

Remarks

In C#, use ISIAPIAssignSchemeDemandScenarios[] to get an AssignSchemeDemandScenario by its name or its position in the collection.
In VBA, use Item() to get an AssignSchemeDemandScenario by its name or use Item_2() to get it by its position.
In C++, use get_Item() to get an AssignSchemeDemandScenario by its name or use get_Item_2() to get it by its position.

Code samples

C#C++Python

var this[] = assignSchemeDemandScenarios.this[];

CComPtr<ISIAPIAssignSchemeDemandScenario> this[];
assignSchemeDemandScenarios->get_this[](&this[]);

this[] = assignSchemeDemandScenarios.this[]

Methods

AssignSchemeDemandScenarioExists(string)

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

bool AssignSchemeDemandScenarioExists(string scenarioName)

Parameters

Name	Type	Description
scenarioName	string	AssignSchemeDemandScenario name to query

Returns bool - Type: System.Bool True, if any AssignSchemeDemandScenario with the given name exists in the collection. False otherwise

Remarks

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

Code samples

C#C++Python

bool result = assignSchemeDemandScenarios.AssignSchemeDemandScenarioExists(@"Example");

VARIANT_BOOL result;
assignSchemeDemandScenarios->AssignSchemeDemandScenarioExists(CComBSTR(L"Example"), &result);

result = assignSchemeDemandScenarios.AssignSchemeDemandScenarioExists(r"Example")