AssignVolumeBins

Type ISIAPIAssignVolumeBins · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 6E4AD386-7D74-4FEB-8D95-3D49862A1D6D

AssignVolumeBin wrapper collection interface

Declaration

[Guid("6E4AD386-7D74-4FEB-8D95-3D49862A1D6D")]
public interface ISIAPIAssignVolumeBins

Members

Properties

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

Methods

Method	Returns	Summary
AssignVolumeBinExists(string)	bool	Queries whether a particular AssignVolumeBin exists in the collection by its name.
GetAssignVolumeBinByID(string)	ISIAPIAssignVolumeBin	Get the AssignVolumeBin by its GUID.

Properties

Count

Gets the number of AssignVolumeBins contained in the collection.

int Count { get; }

Type int

Code samples

C#C++Python

int count = assignVolumeBins.Count;

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

count = assignVolumeBins.Count

this[]

Get the AssignVolumeBin from the collection by its name.

ISIAPIAssignVolumeBin this[] { get; }

Type ISIAPIAssignVolumeBin

Remarks

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

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

Code samples

C#C++Python

var this[] = assignVolumeBins.this[];

CComPtr<ISIAPIAssignVolumeBin> this[];
assignVolumeBins->get_this[](&this[]);

this[] = assignVolumeBins.this[]

this[]

Get the AssignVolumeBin at the specified index.

ISIAPIAssignVolumeBin this[] { get; }

Type ISIAPIAssignVolumeBin

Remarks

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

Code samples

C#C++Python

var this[] = assignVolumeBins.this[];

CComPtr<ISIAPIAssignVolumeBin> this[];
assignVolumeBins->get_this[](&this[]);

this[] = assignVolumeBins.this[]

Methods

AssignVolumeBinExists(string)

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

bool AssignVolumeBinExists(string assignVolumeBinName)

Parameters

Name	Type	Description
assignVolumeBinName	string	AssignVolumeBin name to query

Returns bool - Type: System.Bool True, if any AssignVolumeBin with the given name exists in the collection. False otherwise

Remarks

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

Code samples

C#C++Python

bool result = assignVolumeBins.AssignVolumeBinExists(@"Example");

VARIANT_BOOL result;
assignVolumeBins->AssignVolumeBinExists(CComBSTR(L"Example"), &result);

result = assignVolumeBins.AssignVolumeBinExists(r"Example")

GetAssignVolumeBinByID(string)

Get the AssignVolumeBin by its GUID.

ISIAPIAssignVolumeBin GetAssignVolumeBinByID(string assignVolumeBin_id)

Parameters

Name	Type	Description
assignVolumeBin_id	string	Type: System.String; The GUID of the AssignVolumeBin object, i.e. ISIAPIAssignVolumeBin.AssignVolumeBin_id. This is different from the "Site Volume Bin ID" in the Site Bin Setup dialog, i.e. ISIAPIAssignVolumeBin.ID.

Returns ISIAPIAssignVolumeBin

Code samples

C#C++Python

var result = assignVolumeBins.GetAssignVolumeBinByID(@"id-1");

CComPtr<ISIAPIAssignVolumeBin> result;
assignVolumeBins->GetAssignVolumeBinByID(CComBSTR(L"id-1"), &result);

result = assignVolumeBins.GetAssignVolumeBinByID(r"id-1")