Routes¶

Type ISIAPIRoutes · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID B4E925F0-B40E-4706-AFDF-C4B16C8AA89F

Declaration¶

[Guid("B4E925F0-B40E-4706-AFDF-C4B16C8AA89F")]
public interface ISIAPIRoutes

Members¶

Properties

Property	Type	Summary
Count	`int`
this[]	`ISIAPIRoute`
this[]	`ISIAPIRoute`

Methods

Method	Returns	Summary
RouteExists(string)	`bool`	Queries whether a particular Route exists in the collection

Properties¶

Count¶

int Count { get; }

Type int

Code samples

C#C++PythonPowerShell

int count = routes.Count;

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

count = routes.Count

$count = $routes.Count

this[]¶

ISIAPIRoute this[] { get; }

Type ISIAPIRoute

Code samples

C#C++PythonPowerShell

var this[] = routes.this[];

CComPtr<ISIAPIRoute> this[];
routes->get_this[](&this[]);

this[] = routes.this[]

$this[] = $routes.this[]

this[]¶

ISIAPIRoute this[] { get; }

Type ISIAPIRoute

Code samples

C#C++PythonPowerShell

var this[] = routes.this[];

CComPtr<ISIAPIRoute> this[];
routes->get_this[](&this[]);

this[] = routes.this[]

$this[] = $routes.this[]

Methods¶

RouteExists(string)¶

Queries whether a particular Route exists in the collection

bool RouteExists(string routeName)

Parameters

Name	Type	Description
`routeName`	`string`	Route name to query

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

Code samples

C#C++PythonPowerShell

bool result = routes.RouteExists(@"Example");

VARIANT_BOOL result;
routes->RouteExists(CComBSTR(L"Example"), &result);

result = routes.RouteExists(r"Example")

$result = $routes.RouteExists("Example")