IBatchItemNameGenerator interface
No description yet.
public interface IBatchItemNameGenerator
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| Errors | IStrings | get |
Errors
No description yet.
IStrings Get_Errors();
Type: IStrings · Access: read-only
The accessors are extension methods of IBatchItemNameGeneratorHelper (using DXP;).
Methods
| Method | Returns | Description |
|---|---|---|
| ClearAll | void | |
| GetNextItemHRID | string | |
| IsRunning | bool | |
| RegisterSimpleScheme | void | |
| RetrieveAll | void | |
| RetrieveNew | void | |
| UnregisterSimpleScheme | void | |
| WaitUntillDone | bool |
ClearAll
No description yet.
void ClearAll();
Returns: nothing (void)
GetNextItemHRID
No description yet.
string GetNextItemHRID(IEDMS_Vault argVault, string argSimpleScheme);
string GetNextItemHRID(object argVault, string argSimpleScheme);
| Parameter | Type | Passing |
|---|---|---|
argVault | IEDMS_Vault | value |
argSimpleScheme | string | value |
Returns: string
The first overload is an extension method of IBatchItemNameGeneratorHelper (using DXP;) with typed parameters; the second is declared by the interface.
IsRunning
No description yet.
bool IsRunning();
Returns: bool
RegisterSimpleScheme
No description yet.
void RegisterSimpleScheme(IEDMS_Vault argVault, string argSimpleScheme, int argFirstIndex);
void RegisterSimpleScheme(object argVault, string argSimpleScheme, int argFirstIndex);
| Parameter | Type | Passing |
|---|---|---|
argVault | IEDMS_Vault | value |
argSimpleScheme | string | value |
argFirstIndex | int | value |
Returns: nothing (void)
The first overload is an extension method of IBatchItemNameGeneratorHelper (using DXP;) with typed parameters; the second is declared by the interface.
RetrieveAll
No description yet.
void RetrieveAll(bool argWaitUntilDone);
| Parameter | Type | Passing |
|---|---|---|
argWaitUntilDone | bool | value |
Returns: nothing (void)
RetrieveNew
No description yet.
void RetrieveNew(bool argWaitUntilDone);
| Parameter | Type | Passing |
|---|---|---|
argWaitUntilDone | bool | value |
Returns: nothing (void)
UnregisterSimpleScheme
No description yet.
void UnregisterSimpleScheme(IEDMS_Vault argVault, string argSimpleScheme);
void UnregisterSimpleScheme(object argVault, string argSimpleScheme);
| Parameter | Type | Passing |
|---|---|---|
argVault | IEDMS_Vault | value |
argSimpleScheme | string | value |
Returns: nothing (void)
The first overload is an extension method of IBatchItemNameGeneratorHelper (using DXP;) with typed parameters; the second is declared by the interface.
WaitUntillDone
No description yet.
bool WaitUntillDone();
Returns: bool