Skip to content

AssignSchemeZones

Type ISIAPIAssignSchemeZones · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID AF20B72E-733E-4692-9B44-9D782A7E503F

AssignSchemeZone wrapper collection interface

Declaration

[Guid("AF20B72E-733E-4692-9B44-9D782A7E503F")]
public interface ISIAPIAssignSchemeZones

Members

Properties

Property Type Summary
Count int Gets the number of Assign Scheme Zones contained in the collection.
this[] ISIAPIAssignSchemeZone Get an Assign Scheme Zone by its ID showed in the Assign Bin Setup dialog. Return the Assign Scheme Zone if it exists in the data storage; otherwise, null/Nothing.
this[] ISIAPIAssignSchemeZone Get an Assign Scheme Zone at the specified index.

Methods

Method Returns Summary
AssignSchemeZoneExists(string) bool Queries whether a particular Assign Scheme Zone exists in the collection

Properties

Count

Gets the number of Assign Scheme Zones contained in the collection.

int Count { get; }

Type int

Code samples
int count = assignSchemeZones.Count;
long count;
assignSchemeZones->get_Count(&count);
count = assignSchemeZones.Count

this[]

Get an Assign Scheme Zone by its ID showed in the Assign Bin Setup dialog.
Return the Assign Scheme Zone if it exists in the data storage; otherwise, null/Nothing.

ISIAPIAssignSchemeZone this[] { get; }

Type ISIAPIAssignSchemeZone

Remarks

In C#, use ISIAPIAssignZones[] to get an Assign Scheme Zone by its ID or its position in the collection.
In VBA, use Item() to get an Assign Scheme Zone by its ID or use Item_2() to get it by its position.
In C++, use get_Item() to get an Assign Scheme Zone by its ID or use get_Item_2() to get it by its position.

Code samples
var this[] = assignSchemeZones.this[];
CComPtr<ISIAPIAssignSchemeZone> this[];
assignSchemeZones->get_this[](&this[]);
this[] = assignSchemeZones.this[]

this[]

Get an Assign Scheme Zone at the specified index.

ISIAPIAssignSchemeZone this[] { get; }

Type ISIAPIAssignSchemeZone

Remarks

In C#, use ISIAPIAssignZones[] to get an Assign Scheme Zone by its ID or its position in the collection.
In VBA, use Item() to get an Assign Scheme Zone by its ID or use Item_2() to get it by its position.
In C++, use get_Item() to get an Assign Scheme Zone by its ID or use get_Item_2() to get it by its position.

Code samples
var this[] = assignSchemeZones.this[];
CComPtr<ISIAPIAssignSchemeZone> this[];
assignSchemeZones->get_this[](&this[]);
this[] = assignSchemeZones.this[]

Methods

AssignSchemeZoneExists(string)

Queries whether a particular Assign Scheme Zone exists in the collection

bool AssignSchemeZoneExists(string id)

Parameters

Name Type Description
id string Type: System.String; Zone ID (in the Assign Bin Setup dialog) to query

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

Code samples
bool result = assignSchemeZones.AssignSchemeZoneExists(@"id-1");
VARIANT_BOOL result;
assignSchemeZones->AssignSchemeZoneExists(CComBSTR(L"id-1"), &result);
result = assignSchemeZones.AssignSchemeZoneExists(r"id-1")