Skip to content

SiteVolumeBins

Type ISIAPISiteVolumeBins · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID D5CC5F3A-584F-4075-9877-FED977A3C7A8

SiteVolumeBin collection wrapper interface

Declaration

[Guid("D5CC5F3A-584F-4075-9877-FED977A3C7A8")]
public interface ISIAPISiteVolumeBins

Members

Properties

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

Methods

Method Returns Summary
SiteVolumeBinExists(string) bool Queries whether a particular SiteVolumeBin exists in the collection by its name.
GetSiteVolumeBinByID(string) ISIAPISiteVolumeBin Get the SiteVolumeBin by its GUID.

Properties

Count

Gets the number of SiteVolumeBins contained in the collection.

int Count { get; }

Type int

Code samples 
int count = siteVolumeBins.Count;

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

count = siteVolumeBins.Count

$count = $siteVolumeBins.Count

this[]

Get the SiteVolumeBin from the collection by its name.

ISIAPISiteVolumeBin this[] { get; }

Type ISIAPISiteVolumeBin

Remarks

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

In C#, use ISIAPISiteVolumeBins[] to get a Site by its name or its position in the collection.
In VBA, use Item() to get a SiteVolumeBin by its name or use Item_2() to get by its position.
In C++, use get_Item() to get a SiteVolumeBin by its name or use get_Item_2() by its position.

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

CComPtr<ISIAPISiteVolumeBin> this[];
siteVolumeBins->get_this[](&this[]);

this[] = siteVolumeBins.this[]

$this[] = $siteVolumeBins.this[]

this[]

Get the SiteVolumeBin at the specified index.

ISIAPISiteVolumeBin this[] { get; }

Type ISIAPISiteVolumeBin

Remarks

In C#, use ISIAPISiteVolumeBins[] to get a SiteVolumeBin by its name or its position in the collection.
In VBA, use Item() to get a SiteVolumeBin by its name or use Item_2() to get by its position.
In C++, use get_Item() to get a SiteVolumeBin by its name or use get_Item_2() by its position.

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

CComPtr<ISIAPISiteVolumeBin> this[];
siteVolumeBins->get_this[](&this[]);

this[] = siteVolumeBins.this[]

$this[] = $siteVolumeBins.this[]

Methods

SiteVolumeBinExists(string)

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

bool SiteVolumeBinExists(string siteVolumeBinName)

Parameters

Name Type Description
siteVolumeBinName string SiteVolumeBin name to query

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

Remarks

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

Code samples 
bool result = siteVolumeBins.SiteVolumeBinExists(@"Example");

VARIANT_BOOL result;
siteVolumeBins->SiteVolumeBinExists(CComBSTR(L"Example"), &result);

result = siteVolumeBins.SiteVolumeBinExists(r"Example")

$result = $siteVolumeBins.SiteVolumeBinExists("Example")

GetSiteVolumeBinByID(string)

Get the SiteVolumeBin by its GUID.

ISIAPISiteVolumeBin GetSiteVolumeBinByID(string siteVolumeBin_id)

Parameters

Name Type Description
siteVolumeBin_id string The GUID of the SiteVolumeBin object, i.e. ISIAPISiteVolumeBin.SiteVolumeBin_id. This is different from the "Site Volume Bin ID" in the Site Bin Setup dialog, i.e. ISIAPISiteVolumeBin.ID.

Returns ISIAPISiteVolumeBin

Code samples 
var result = siteVolumeBins.GetSiteVolumeBinByID(@"id-1");

CComPtr<ISIAPISiteVolumeBin> result;
siteVolumeBins->GetSiteVolumeBinByID(CComBSTR(L"id-1"), &result);

result = siteVolumeBins.GetSiteVolumeBinByID(r"id-1")

$result = $siteVolumeBins.GetSiteVolumeBinByID("id-1")