AssignZones

Type ISIAPIAssignZones · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID D4C2423A-ACA1-462C-95E9-65E66330ABEA

AssignZone wrapper collection interface

Declaration

[Guid("D4C2423A-ACA1-462C-95E9-65E66330ABEA")]
public interface ISIAPIAssignZones

Members

Properties

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

Methods

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

Properties

Count

Gets the number of Assign Zones contained in the collection.

int Count { get; }

Type int

Code samples

C#C++Python

int count = assignZones.Count;

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

count = assignZones.Count

this[]

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

ISIAPIAssignZone this[] { get; }

Type ISIAPIAssignZone

Remarks

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

Code samples

C#C++Python

var this[] = assignZones.this[];

CComPtr<ISIAPIAssignZone> this[];
assignZones->get_this[](&this[]);

this[] = assignZones.this[]

this[]

Get an Assign Zone at the specified index.

ISIAPIAssignZone this[] { get; }

Type ISIAPIAssignZone

Remarks

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

Code samples

C#C++Python

var this[] = assignZones.this[];

CComPtr<ISIAPIAssignZone> this[];
assignZones->get_this[](&this[]);

this[] = assignZones.this[]

Methods

AssignZoneExists(string)

Queries whether a particular Assign Zone exists in the collection

bool AssignZoneExists(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

C#C++Python

bool result = assignZones.AssignZoneExists(@"id-1");

VARIANT_BOOL result;
assignZones->AssignZoneExists(CComBSTR(L"id-1"), &result);

result = assignZones.AssignZoneExists(r"id-1")