Skip to content

ISIAPILegs Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 2FE4DC80-7A11-44B8-8785-5456BDB7CA76

Declaration

[Guid("2FE4DC80-7A11-44B8-8785-5456BDB7CA76")]
public interface ISIAPILegs

Get an instance

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

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

# Navigate to the ISIAPILegs you need via the ISIAPI tree.
# See ISIAPI for the activation root.
legs = ...

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

Properties

Count

int Count { get; }

Type int

Code samples 
int count = legs.Count;

Dim count As Integer = legs.Count

count = legs.Count

$count = $legs.Count

this[]

Get a Leg.
Return a Leg if it exists in the data storage; otherwise, null/Nothing.

ISIAPILeg this[] { get; }

Type ISIAPILeg

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

Dim this[] As ISIAPILeg = legs.this[]

this[] = legs.this[]

$this[] = $legs.this[]

Methods

LegExists(int)

Get a value indicating whether a Leg exists in the data storage.

bool LegExists(int orientation)

Parameters

Name Type Description
orientation int One of: - 0 - South - 1 - South East - 2 - East - 3 - North East - 4 - North - 5 - North West - 6 - West - 7 - South West

Returns bool - true if it exists in the data storage; otherwise, false

Code samples 
bool result = legs.LegExists(0);

Dim result As Boolean = legs.LegExists(0)

result = legs.LegExists(0)

$result = $legs.LegExists(0)