ISIAPISiteVolumeBinFolders Interface¶

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: B602B00A-E559-413F-BE3C-0904AB67B1CE

SiteVolumeBinFolder collection wrapper interface

Declaration¶

[Guid("B602B00A-E559-413F-BE3C-0904AB67B1CE")]
public interface ISIAPISiteVolumeBinFolders

Get an instance¶

C#VB.NETPythonPowerShell

// Navigate to the ISIAPISiteVolumeBinFolders you need via the ISIAPI tree.
// See ISIAPI for the activation root.
var siteVolumeBinFolders = /* ... */;

' Navigate to the ISIAPISiteVolumeBinFolders you need via the ISIAPI tree.
' See ISIAPI for the activation root.
Dim siteVolumeBinFolders As ISIAPISiteVolumeBinFolders = Nothing

# Navigate to the ISIAPISiteVolumeBinFolders you need via the ISIAPI tree.
# See ISIAPI for the activation root.
siteVolumeBinFolders = ...

# Navigate to the ISIAPISiteVolumeBinFolders you need via the ISIAPI tree.
# See ISIAPI for the activation root.
$siteVolumeBinFolders = $null

Properties¶

Count¶

Gets the number of SiteVolumeBinFolders contained in the collection.

int Count { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int count = siteVolumeBinFolders.Count;

Dim count As Integer = siteVolumeBinFolders.Count

count = siteVolumeBinFolders.Count

$count = $siteVolumeBinFolders.Count

this[]¶

Get the SiteVolumeBinFolder from the collection by the Folder name.

ISIAPISiteVolumeBinFolder this[] { get; }

Type ISIAPISiteVolumeBinFolder

Remarks

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

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

Code samples

C#VB.NETPythonPowerShell

var this[] = siteVolumeBinFolders.this[];

Dim this[] As ISIAPISiteVolumeBinFolder = siteVolumeBinFolders.this[]

this[] = siteVolumeBinFolders.this[]

$this[] = $siteVolumeBinFolders.this[]

this[]¶

Get the SiteVolumeBinFolder at the specified index.

ISIAPISiteVolumeBinFolder this[] { get; }

Type ISIAPISiteVolumeBinFolder

Remarks

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

Code samples

C#VB.NETPythonPowerShell

var this[] = siteVolumeBinFolders.this[];

Dim this[] As ISIAPISiteVolumeBinFolder = siteVolumeBinFolders.this[]

this[] = siteVolumeBinFolders.this[]

$this[] = $siteVolumeBinFolders.this[]

Methods¶

SiteVolumeBinFolderExists(string)¶

Queries whether a particular SiteVolumeBinFolder exists in the collection

bool SiteVolumeBinFolderExists(string name)

Parameters

Name	Type	Description
`name`	`string`	SiteVolumeBinFolder name to query

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

Remarks

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

Code samples

C#VB.NETPythonPowerShell

bool result = siteVolumeBinFolders.SiteVolumeBinFolderExists(@"Example");

Dim result As Boolean = siteVolumeBinFolders.SiteVolumeBinFolderExists("Example")

result = siteVolumeBinFolders.SiteVolumeBinFolderExists(r"Example")

$result = $siteVolumeBinFolders.SiteVolumeBinFolderExists("Example")