# IVcsManager interface

*No description yet.*

```csharp
public interface IVcsManager
```

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

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [SVNDbLibRepositoryCacheFolder](#svndblibrepositorycachefolder) | `string` | get; set |  |
| [SVNDbLibRepositoryWorkingFolder](#svndblibrepositoryworkingfolder) | `string` | get; set |  |
| [SVNDbLibUpdateThreshold](#svndblibupdatethreshold) | `int` | get; set |  |

### SVNDbLibRepositoryCacheFolder

*No description yet.*

```csharp
string GetState_SVNDbLibRepositoryCacheFolder();
void SetState_SVNDbLibRepositoryCacheFolder(string argValue);
```

**Type:** `string` · **Access:** read/write

### SVNDbLibRepositoryWorkingFolder

*No description yet.*

```csharp
string GetState_SVNDbLibRepositoryWorkingFolder();
void SetState_SVNDbLibRepositoryWorkingFolder(string argValue);
```

**Type:** `string` · **Access:** read/write

### SVNDbLibUpdateThreshold

*No description yet.*

```csharp
int GetState_SVNDbLibUpdateThreshold();
void SetState_SVNDbLibUpdateThreshold(int argValue);
```

**Type:** `int` · **Access:** read/write

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [BackgroundGetRevisions](#backgroundgetrevisions) | [IVcsRevisions](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsRevisions.md) |  |
| [BackgroundGetStatus](#backgroundgetstatus) | [TVCSStatusSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TVCSStatusSet.md) |  |
| [BackgroundGetStatusString](#backgroundgetstatusstring) | `string` |  |
| [CheckoutSVNDBLIBWorkingFolders](#checkoutsvndblibworkingfolders) | `bool` |  |
| [CommitInteractively](#commitinteractively) | `string` |  |
| [CreateVcsProject](#createvcsproject) | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) |  |
| [GetDeletedFileList](#getdeletedfilelist) | [IVcsFileNames](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsFileNames.md) |  |
| [GetDocumentStatus](#getdocumentstatus) | [TVCSStatusSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TVCSStatusSet.md) |  |
| [GetLocationInRepository](#getlocationinrepository) | `string` |  |
| [GetProjectFromVcs](#getprojectfromvcs) | `string` |  |
| [GetProviderByType](#getproviderbytype) | [IVcsProvider](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProvider.md) |  |
| [GetRevisions](#getrevisions) | [IVcsRevisions](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsRevisions.md) |  |
| [GetStatus](#getstatus) | [TVCSStatusSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TVCSStatusSet.md) |  |
| [GetStatusString](#getstatusstring) | `string` |  |
| [GetSVNDblibDocForDocument](#getsvndblibdocfordocument) | [IDXPSVNDatabaseLibDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPSVNDatabaseLibDocument.md) |  |
| [GetSVNDblibWorkingDirectoryNameFromRepositoryPath](#getsvndblibworkingdirectorynamefromrepositorypath) | `string` |  |
| [GetVcsFileNamesFactory](#getvcsfilenamesfactory) | [IVcsFileNamesFactory](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsFileNamesFactory.md) |  |
| [GetVcsRevisionString](#getvcsrevisionstring) | `string` |  |
| [GetVcsRevisionStringForDocument](#getvcsrevisionstringfordocument) | `string` |  |
| [GetVcsRevisionStringForDocumentExt](#getvcsrevisionstringfordocumentext) | `string` |  |
| [IsVCSActive](#isvcsactive) | `bool` |  |
| [ListenForVCSStatusChanges](#listenforvcsstatuschanges) | `void` |  |
| [NeedToCheckoutSVNDBLIBWorkingFolders](#needtocheckoutsvndblibworkingfolders) | `bool` |  |
| [Refresh](#refresh) | `void` |  |
| [StopListeningForVCSStatusChanges](#stoplisteningforvcsstatuschanges) | `void` |  |
| [UpdateInteractively](#updateinteractively) | `string` |  |

### BackgroundGetRevisions

*No description yet.*

```csharp
IVcsRevisions BackgroundGetRevisions(IVcsProject argVCSProject, string argFullPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argFullPath` | `string` | value |

**Returns:** [IVcsRevisions](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsRevisions.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### BackgroundGetStatus

*No description yet.*

```csharp
TVCSStatusSet BackgroundGetStatus(IVcsProject argVCSProject, string argFullPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argFullPath` | `string` | value |

**Returns:** [TVCSStatusSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TVCSStatusSet.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### BackgroundGetStatusString

*No description yet.*

```csharp
string BackgroundGetStatusString(IVcsProject argVCSProject, string argFullPath);
string BackgroundGetStatusString(object argVCSProject, string argFullPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argFullPath` | `string` | value |

**Returns:** `string`

The first overload is an extension method of `IVcsManagerHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### CheckoutSVNDBLIBWorkingFolders

*No description yet.*

```csharp
bool CheckoutSVNDBLIBWorkingFolders(IDXPSVNDatabaseLibDocument argSVNDbLibDoc);
bool CheckoutSVNDBLIBWorkingFolders(object argSVNDbLibDoc);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argSVNDbLibDoc` | [IDXPSVNDatabaseLibDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPSVNDatabaseLibDocument.md) | value |

**Returns:** `bool`

The first overload is an extension method of `IVcsManagerHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### CommitInteractively

*No description yet.*

```csharp
string CommitInteractively(IVcsProject argVCSProject, IVcsFileNames argFileNames);
string CommitInteractively(object argVCSProject, object argFileNames);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argFileNames` | [IVcsFileNames](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsFileNames.md) | value |

**Returns:** `string`

The first overload is an extension method of `IVcsManagerHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### CreateVcsProject

*No description yet.*

```csharp
IVcsProject CreateVcsProject(IDXPProject argProject, string argProjectFullPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProject` | [IDXPProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPProject.md) | value |
| `argProjectFullPath` | `string` | value |

**Returns:** [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### GetDeletedFileList

*No description yet.*

```csharp
IVcsFileNames GetDeletedFileList(IVcsProject argVCSProject);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |

**Returns:** [IVcsFileNames](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsFileNames.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### GetDocumentStatus

*No description yet.*

```csharp
TVCSStatusSet GetDocumentStatus(string argDocument);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDocument` | `string` | value |

**Returns:** [TVCSStatusSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TVCSStatusSet.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### GetLocationInRepository

*No description yet.*

```csharp
string GetLocationInRepository(IVcsProject argVCSProject, string argFullPath);
string GetLocationInRepository(object argVCSProject, string argFullPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argFullPath` | `string` | value |

**Returns:** `string`

The first overload is an extension method of `IVcsManagerHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### GetProjectFromVcs

*No description yet.*

```csharp
string GetProjectFromVcs(string argLocalPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argLocalPath` | `string` | value |

**Returns:** `string`

### GetProviderByType

*No description yet.*

```csharp
IVcsProvider GetProviderByType(TProviderType argProviderType);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProviderType` | [TProviderType](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TProviderType.md) | value |

**Returns:** [IVcsProvider](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProvider.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### GetRevisions

*No description yet.*

```csharp
IVcsRevisions GetRevisions(IVcsProject argVCSProject, string argFullPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argFullPath` | `string` | value |

**Returns:** [IVcsRevisions](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsRevisions.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### GetStatus

*No description yet.*

```csharp
TVCSStatusSet GetStatus(IVcsProject argVCSProject, string argFullPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argFullPath` | `string` | value |

**Returns:** [TVCSStatusSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TVCSStatusSet.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### GetStatusString

*No description yet.*

```csharp
string GetStatusString(IVcsProject argVCSProject, string argFullPath);
string GetStatusString(object argVCSProject, string argFullPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argFullPath` | `string` | value |

**Returns:** `string`

The first overload is an extension method of `IVcsManagerHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### GetSVNDblibDocForDocument

*No description yet.*

```csharp
IDXPSVNDatabaseLibDocument GetSVNDblibDocForDocument(IDXPDocument argDocument);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDocument` | [IDXPDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPDocument.md) | value |

**Returns:** [IDXPSVNDatabaseLibDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPSVNDatabaseLibDocument.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### GetSVNDblibWorkingDirectoryNameFromRepositoryPath

*No description yet.*

```csharp
string GetSVNDblibWorkingDirectoryNameFromRepositoryPath(string argRepositoryPath, string argRepositoryURL);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argRepositoryPath` | `string` | value |
| `argRepositoryURL` | `string` | value |

**Returns:** `string`

### GetVcsFileNamesFactory

*No description yet.*

```csharp
IVcsFileNamesFactory GetVcsFileNamesFactory();
```

**Returns:** [IVcsFileNamesFactory](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsFileNamesFactory.md)

Extension method of `IVcsManagerHelper` (`using DXP;`).

### GetVcsRevisionString

*No description yet.*

```csharp
string GetVcsRevisionString(IVcsRevisions argRevisions, TVCSStatusSet argRevStatus);
string GetVcsRevisionString(object argRevisions, ITransportSet argRevStatus);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argRevisions` | [IVcsRevisions](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsRevisions.md) | value |
| `argRevStatus` | [TVCSStatusSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TVCSStatusSet.md) | value |

**Returns:** `string`

The first overload is an extension method of `IVcsManagerHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### GetVcsRevisionStringForDocument

*No description yet.*

```csharp
string GetVcsRevisionStringForDocument(string argFileName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argFileName` | `string` | value |

**Returns:** `string`

### GetVcsRevisionStringForDocumentExt

*No description yet.*

```csharp
string GetVcsRevisionStringForDocumentExt(string argFileName, bool argIsShortFormat);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argFileName` | `string` | value |
| `argIsShortFormat` | `bool` | value |

**Returns:** `string`

### IsVCSActive

*No description yet.*

```csharp
bool IsVCSActive();
```

**Returns:** `bool`

### ListenForVCSStatusChanges

*No description yet.*

```csharp
void ListenForVCSStatusChanges(uint argHandle);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argHandle` | `uint` | value |

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

### NeedToCheckoutSVNDBLIBWorkingFolders

*No description yet.*

```csharp
bool NeedToCheckoutSVNDBLIBWorkingFolders(IDXPSVNDatabaseLibDocument argSVNDbLibDoc);
bool NeedToCheckoutSVNDBLIBWorkingFolders(object argSVNDbLibDoc);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argSVNDbLibDoc` | [IDXPSVNDatabaseLibDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPSVNDatabaseLibDocument.md) | value |

**Returns:** `bool`

The first overload is an extension method of `IVcsManagerHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### Refresh

*No description yet.*

```csharp
void Refresh(IVcsFileNames argDocuments);
void Refresh(object argDocuments);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDocuments` | [IVcsFileNames](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsFileNames.md) | value |

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

The first overload is an extension method of `IVcsManagerHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### StopListeningForVCSStatusChanges

*No description yet.*

```csharp
void StopListeningForVCSStatusChanges(uint argHandle);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argHandle` | `uint` | value |

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

### UpdateInteractively

*No description yet.*

```csharp
string UpdateInteractively(IVcsProject argVCSProject, IVcsFileNames argFileNames);
string UpdateInteractively(object argVCSProject, object argFileNames);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argFileNames` | [IVcsFileNames](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsFileNames.md) | value |

**Returns:** `string`

The first overload is an extension method of `IVcsManagerHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.