Legs

Type 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

Members

Properties

Property	Type	Summary
Count	int
this[]	ISIAPILeg	Get a Leg. Return a Leg if it exists in the data storage; otherwise, null/Nothing.

Methods

Method	Returns	Summary
LegExists(int)	bool	Get a value indicating whether a Leg exists in the data storage.

Properties

Count

int Count { get; }

Type int

Code samples

C#C++PythonPowerShell

int count = legs.Count;

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

C#C++PythonPowerShell

var this[] = legs.this[];

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

C#C++PythonPowerShell

bool result = legs.LegExists(0);

VARIANT_BOOL result;
legs->LegExists(0, &result);

result = legs.LegExists(0)

$result = $legs.LegExists(0)