# IBatchItemNameGenerator interface

*No description yet.*

```csharp
public interface IBatchItemNameGenerator
```

**Namespace:** DXP · **Assembly:** Altium.SDK.Interfaces

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [Errors](#errors) | [IStrings](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IStrings.md) | get |  |

### Errors

*No description yet.*

```csharp
IStrings Get_Errors();
```

**Type:** [IStrings](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IStrings.md) · **Access:** read-only

The accessors are extension methods of `IBatchItemNameGeneratorHelper` (`using DXP;`).

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [ClearAll](#clearall) | `void` |  |
| [GetNextItemHRID](#getnextitemhrid) | `string` |  |
| [IsRunning](#isrunning) | `bool` |  |
| [RegisterSimpleScheme](#registersimplescheme) | `void` |  |
| [RetrieveAll](#retrieveall) | `void` |  |
| [RetrieveNew](#retrievenew) | `void` |  |
| [UnregisterSimpleScheme](#unregistersimplescheme) | `void` |  |
| [WaitUntillDone](#waituntilldone) | `bool` |  |

### ClearAll

*No description yet.*

```csharp
void ClearAll();
```

**Returns:** nothing (`void`)

### GetNextItemHRID

*No description yet.*

```csharp
string GetNextItemHRID(IEDMS_Vault argVault, string argSimpleScheme);
string GetNextItemHRID(object argVault, string argSimpleScheme);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVault` | [IEDMS_Vault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_Vault.md) | 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.*

```csharp
bool IsRunning();
```

**Returns:** `bool`

### RegisterSimpleScheme

*No description yet.*

```csharp
void RegisterSimpleScheme(IEDMS_Vault argVault, string argSimpleScheme, int argFirstIndex);
void RegisterSimpleScheme(object argVault, string argSimpleScheme, int argFirstIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVault` | [IEDMS_Vault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_Vault.md) | 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.*

```csharp
void RetrieveAll(bool argWaitUntilDone);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argWaitUntilDone` | `bool` | value |

**Returns:** nothing (`void`)

### RetrieveNew

*No description yet.*

```csharp
void RetrieveNew(bool argWaitUntilDone);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argWaitUntilDone` | `bool` | value |

**Returns:** nothing (`void`)

### UnregisterSimpleScheme

*No description yet.*

```csharp
void UnregisterSimpleScheme(IEDMS_Vault argVault, string argSimpleScheme);
void UnregisterSimpleScheme(object argVault, string argSimpleScheme);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVault` | [IEDMS_Vault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_Vault.md) | 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.*

```csharp
bool WaitUntillDone();
```

**Returns:** `bool`

## Returned by

[IComponentLibraryManager.GetItemNameGenerator](https://altiumdeveloper.github.io/ad-sdk-docs/reference/componentlib/IComponentLibraryManager.md#getitemnamegenerator)