Skip to content

SiteVolumeLegs

Type ISIAPISiteVolumeLegs · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 054C4737-ACF6-42B1-AF5B-B5F6358FD3CA

Declaration

[Guid("054C4737-ACF6-42B1-AF5B-B5F6358FD3CA")]
public interface ISIAPISiteVolumeLegs

Members

Properties

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

Methods

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

Properties

Count

int Count { get; }

Type int

Code samples 
int count = siteVolumeLegs.Count;

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

count = siteVolumeLegs.Count

$count = $siteVolumeLegs.Count

this[]

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

ISIAPISiteVolumeLeg this[] { get; }

Type ISIAPISiteVolumeLeg

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

CComPtr<ISIAPISiteVolumeLeg> this[];
siteVolumeLegs->get_this[](&this[]);

this[] = siteVolumeLegs.this[]

$this[] = $siteVolumeLegs.this[]

Methods

LegExists(int)

Get a value indicating whether a Site Volume Bin 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 = siteVolumeLegs.LegExists(0);

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

result = siteVolumeLegs.LegExists(0)

$result = $siteVolumeLegs.LegExists(0)