IVcsBasedProjectCommands interface

No description yet.

public interface IVcsBasedProjectCommands

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
AddProjectFolderToVCS	void
AddProjectToVCSNoUI	bool
AddVCSRepository	bool
CheckoutProjectNoUI	void
CommitProject	void
GetDesignVaultByGUID	IVcsDesignVault
GetDesignVaultByPath	IVcsDesignVault
GetVcsProvider	IVcsProvider
GetVcsProvidersCount	int
SelectRepositoryPath	bool

AddProjectFolderToVCS

No description yet.

void AddProjectFolderToVCS(IVcsProject argVCSProject, IVcsDesignVault argDesignVault, string argProjectFileName, string argProjectVCSPath);
void AddProjectFolderToVCS(object argVCSProject, object argDesignVault, string argProjectFileName, string argProjectVCSPath);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argDesignVault	IVcsDesignVault	value
argProjectFileName	string	value
argProjectVCSPath	string	value

Returns: nothing (void)

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

AddProjectToVCSNoUI

No description yet.

bool AddProjectToVCSNoUI(IVcsProject argVCSProject, IVcsDesignVault argDesignVault, IVcsFileNames argFileNames, string argProject, string argProjectVCSPath, string argComment);
bool AddProjectToVCSNoUI(object argVCSProject, object argDesignVault, object argFileNames, string argProject, string argProjectVCSPath, string argComment);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argDesignVault	IVcsDesignVault	value
argFileNames	IVcsFileNames	value
argProject	string	value
argProjectVCSPath	string	value
argComment	string	value

Returns: bool

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

AddVCSRepository

No description yet.

bool AddVCSRepository(string argRepositoryName, string argRepositoryPath, string argManagedRepositoryGUID, string argWorkingCopyDir, TProviderType argProviderType, TCreateKind argCreateKind, TRepositoryType argRepositoryType);
bool AddVCSRepository(string argRepositoryName, string argRepositoryPath, string argManagedRepositoryGUID, string argWorkingCopyDir, int argProviderType, int argCreateKind, int argRepositoryType);

Parameter	Type	Passing
argRepositoryName	string	value
argRepositoryPath	string	value
argManagedRepositoryGUID	string	value
argWorkingCopyDir	string	value
argProviderType	TProviderType	value
argCreateKind	TCreateKind	value
argRepositoryType	TRepositoryType	value

Returns: bool

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

CheckoutProjectNoUI

No description yet.

void CheckoutProjectNoUI(IVcsDesignVault argDesignVault, string argLocalPath, string argVCSPath, string argRelPath, int argRevisionID);
void CheckoutProjectNoUI(object argDesignVault, string argLocalPath, string argVCSPath, string argRelPath, int argRevisionID);

Parameter	Type	Passing
argDesignVault	IVcsDesignVault	value
argLocalPath	string	value
argVCSPath	string	value
argRelPath	string	value
argRevisionID	int	value

Returns: nothing (void)

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

CommitProject

No description yet.

void CommitProject(IVcsProject argVCSProject, string argProject);
void CommitProject(object argVCSProject, string argProject);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argProject	string	value

Returns: nothing (void)

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

GetDesignVaultByGUID

No description yet.

IVcsDesignVault GetDesignVaultByGUID(string argRepositoryGUID);

Parameter	Type	Passing
argRepositoryGUID	string	value

Returns: IVcsDesignVault

Extension method of IVcsBasedProjectCommandsHelper (using DXP;).

GetDesignVaultByPath

No description yet.

IVcsDesignVault GetDesignVaultByPath(string argRepositoryPath);

Parameter	Type	Passing
argRepositoryPath	string	value

Returns: IVcsDesignVault

Extension method of IVcsBasedProjectCommandsHelper (using DXP;).

GetVcsProvider

No description yet.

IVcsProvider GetVcsProvider(int argIndex, out bool argEnabled);

Parameter	Type	Passing
argIndex	int	value
argEnabled	bool	out

Returns: IVcsProvider

Extension method of IVcsBasedProjectCommandsHelper (using DXP;).

GetVcsProvidersCount

No description yet.

int GetVcsProvidersCount();

Returns: int

SelectRepositoryPath

No description yet.

bool SelectRepositoryPath(IVcsDesignVault argDesignVault, ref string argProjectVCSPath);
bool SelectRepositoryPath(object argDesignVault, ref string argProjectVCSPath);

Parameter	Type	Passing
argDesignVault	IVcsDesignVault	value
argProjectVCSPath	string	ref

Returns: bool

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