IVcsProject interface

No description yet.

public interface IVcsProject

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Derived: ICloudVCSVcsProject, IGitVcsProject

Properties

Property	Type	Access	Description
AuxProj	string	get; set
LocalProj	string	get; set
Project	IDXPProject	get; set
ProjectName	string	get; set
UserName	string	get; set

AuxProj

No description yet.

string GetAuxProj();
void SetAuxProj(string argValue);

Type: string · Access: read/write

LocalProj

No description yet.

string GetLocalProj();
void SetLocalProj(string argValue);

Type: string · Access: read/write

Project

No description yet.

IDXPProject GetProject();
void SetProject(IDXPProject argProject);

Type: IDXPProject · Access: read/write

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

ProjectName

No description yet.

string GetProjectName();
void SetProjectName(string argValue);

Type: string · Access: read/write

UserName

No description yet.

string GetUserName();
void SetUserName(string argValue);

Type: string · Access: read/write

Methods

Method	Returns	Description
Add	string
BringToDate	void
CanGetLocationInRepository	bool
CheckIn	int
CheckInKeep	int
CheckoutProject	string
CheckoutProjectSilently	string
CleanUp	int
CloseProject	int
Commit	int
CommitEx	int
Delete	string
DesignVault	IVcsDesignVault
DesignVaultName	string
Diff	int
Export	string
Get	int
GetAllRepositoryFiles	void
GetCanCache	bool
GetCommandOptions	int
GetConnected	bool
GetFilenameUniqueIDForRepository	string
GetLocalStatus	TVCSStatusSet
GetLocationInRepository	string
GetOldPath	string
GetOldPaths	void
GetProjPath	int
GetRepositoryRoot	string
GetRevision	int
GetRevisions	IVcsRevisions
GetStatus	TVCSStatusSet
GetStatusWithPrefetch	TVCSStatusSet
GetUseCommit	bool
GetWorkingCopyRoot	string
History	int
InitializeAndAddFiles	void
IsThreadSafe	bool
LinkLocalFolder	void
List	void
LoadFromFile	void
Lock	int
OpenProject	int
Properties	int
ProviderType	TProviderType
Remove	int
RemoveProject	int
Rename	int
Resolve	int
Restore	string
Revert	string
RevertEx	string
RunVcs	int
SaveToFile	void
SupportsCommand	bool
SwitchTo	void
SwitchTo_2	void
Unlock	int
Update	int

Add

No description yet.

string Add(IVcsFileNames argFileNames, string argComment, TVcsAddFlagSet argFlags);
string Add(object argFileNames, string argComment, ITransportSet argFlags);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argComment	string	value
argFlags	TVcsAddFlagSet	value

Returns: string

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

BringToDate

No description yet.

void BringToDate(string argLocalFolderFullPath);

Parameter	Type	Passing
argLocalFolderFullPath	string	value

Returns: nothing (void)

CanGetLocationInRepository

No description yet.

bool CanGetLocationInRepository();

Returns: bool

CheckIn

No description yet.

int CheckIn(IVcsFileNames argFileNames, string argComment);
int CheckIn(object argFileNames, string argComment);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argComment	string	value

Returns: int

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

CheckInKeep

No description yet.

int CheckInKeep(IVcsFileNames argFileNames, string argComment);
int CheckInKeep(object argFileNames, string argComment);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argComment	string	value

Returns: int

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

CheckoutProject

No description yet.

string CheckoutProject(IVcsDesignVault argDesignVault, string argPath, string argLocalPath, string argRelPath);
string CheckoutProject(object argDesignVault, string argPath, string argLocalPath, string argRelPath);

Parameter	Type	Passing
argDesignVault	IVcsDesignVault	value
argPath	string	value
argLocalPath	string	value
argRelPath	string	value

Returns: string

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

CheckoutProjectSilently

No description yet.

string CheckoutProjectSilently();

Returns: string

CleanUp

No description yet.

int CleanUp(IVcsFileNames argFolders);
int CleanUp(object argFolders);

Parameter	Type	Passing
argFolders	IVcsFileNames	value

Returns: int

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

CloseProject

No description yet.

int CloseProject();

Returns: int

Commit

No description yet.

int Commit(IVcsFileNames argFileNames, string argComment);
int Commit(object argFileNames, string argComment);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argComment	string	value

Returns: int

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

CommitEx

No description yet.

int CommitEx(IVcsFileNames argFileNames, long argCommitTime, string arguthor, string argComment);
int CommitEx(object argFileNames, long argCommitTime, string arguthor, string argComment);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argCommitTime	long	value
arguthor	string	value
argComment	string	value

Returns: int

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

Delete

No description yet.

string Delete(IVcsFileNames argFileNames);
string Delete(object argFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value

Returns: string

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

DesignVault

No description yet.

IVcsDesignVault DesignVault();

Returns: IVcsDesignVault

Extension method of IVcsProjectHelper (using DXP;).

DesignVaultName

No description yet.

string DesignVaultName();

Returns: string

Diff

No description yet.

int Diff(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: int

Export

No description yet.

string Export(string argFileName, string argLocalDirectory);

Parameter	Type	Passing
argFileName	string	value
argLocalDirectory	string	value

Returns: string

Get

No description yet.

int Get(IVcsFileNames argFileNames);
int Get(object argFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value

Returns: int

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

GetAllRepositoryFiles

No description yet.

void GetAllRepositoryFiles(IVcsFileNames argFileNames);
void GetAllRepositoryFiles(object argFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value

Returns: nothing (void)

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

GetCanCache

No description yet.

bool GetCanCache();

Returns: bool

GetCommandOptions

No description yet.

int GetCommandOptions(TVcsCommand argCommand);
int GetCommandOptions(int argCommand);

Parameter	Type	Passing
argCommand	TVcsCommand	value

Returns: int

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

GetConnected

No description yet.

bool GetConnected();

Returns: bool

GetFilenameUniqueIDForRepository

No description yet.

string GetFilenameUniqueIDForRepository(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: string

GetLocalStatus

No description yet.

TVCSStatusSet GetLocalStatus(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: TVCSStatusSet

Extension method of IVcsProjectHelper (using DXP;).

GetLocationInRepository

No description yet.

string GetLocationInRepository(string argFullPath);

Parameter	Type	Passing
argFullPath	string	value

Returns: string

GetOldPath

No description yet.

string GetOldPath(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: string

GetOldPaths

No description yet.

void GetOldPaths(IVcsFileNames argFileNames, out IVcsFileNames argOldFileNames);
void GetOldPaths(object argFileNames, out IVcsFileNames argOldFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argOldFileNames	IVcsFileNames	out

Returns: nothing (void)

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

GetProjPath

No description yet.

int GetProjPath(IVcsDesignVault argDesignVault);
int GetProjPath(object argDesignVault);

Parameter	Type	Passing
argDesignVault	IVcsDesignVault	value

Returns: int

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

GetRepositoryRoot

No description yet.

string GetRepositoryRoot();

Returns: string

GetRevision

No description yet.

int GetRevision(string argFileName, string argRevision, string argRevisionFileName);

Parameter	Type	Passing
argFileName	string	value
argRevision	string	value
argRevisionFileName	string	value

Returns: int

GetRevisions

No description yet.

IVcsRevisions GetRevisions(string argFileName, IVcsBackgroundThread argThread);

Parameter	Type	Passing
argFileName	string	value
argThread	IVcsBackgroundThread	value

Returns: IVcsRevisions

Extension method of IVcsProjectHelper (using DXP;).

GetStatus

No description yet.

TVCSStatusSet GetStatus(string argFileName, IVcsBackgroundThread argThread);

Parameter	Type	Passing
argFileName	string	value
argThread	IVcsBackgroundThread	value

Returns: TVCSStatusSet

Extension method of IVcsProjectHelper (using DXP;).

GetStatusWithPrefetch

No description yet.

TVCSStatusSet GetStatusWithPrefetch(string argFileName, IVcsBackgroundThread argThread);

Parameter	Type	Passing
argFileName	string	value
argThread	IVcsBackgroundThread	value

Returns: TVCSStatusSet

Extension method of IVcsProjectHelper (using DXP;).

GetUseCommit

No description yet.

bool GetUseCommit();

Returns: bool

GetWorkingCopyRoot

No description yet.

string GetWorkingCopyRoot();

Returns: string

History

No description yet.

int History(IVcsFileNames argFileNames);
int History(object argFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value

Returns: int

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

InitializeAndAddFiles

No description yet.

void InitializeAndAddFiles(VCSAddFilesSettings argSettings);
void InitializeAndAddFiles(IVCSAddFilesSettings argSettings);

Parameter	Type	Passing
argSettings	VCSAddFilesSettings	value

Returns: nothing (void)

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

IsThreadSafe

No description yet.

bool IsThreadSafe();

Returns: bool

LinkLocalFolder

No description yet.

void LinkLocalFolder(string argLocalFolderFullPath);

Parameter	Type	Passing
argLocalFolderFullPath	string	value

Returns: nothing (void)

List

No description yet.

void List(string argLocalFolderFullPath, IVcsFileNames argFileNames);
void List(string argLocalFolderFullPath, object argFileNames);

Parameter	Type	Passing
argLocalFolderFullPath	string	value
argFileNames	IVcsFileNames	value

Returns: nothing (void)

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

LoadFromFile

No description yet.

void LoadFromFile(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: nothing (void)

Lock

No description yet.

int Lock(IVcsFileNames argFileNames, string argComment);
int Lock(object argFileNames, string argComment);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argComment	string	value

Returns: int

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

OpenProject

No description yet.

int OpenProject();

Returns: int

Properties

No description yet.

int Properties(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: int

ProviderType

No description yet.

TProviderType ProviderType();

Returns: TProviderType

Extension method of IVcsProjectHelper (using DXP;).

Remove

No description yet.

int Remove(IVcsFileNames argFileNames, string argComment);
int Remove(object argFileNames, string argComment);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argComment	string	value

Returns: int

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

RemoveProject

No description yet.

int RemoveProject(IVcsFileNames argFileNames, string argComment);
int RemoveProject(object argFileNames, string argComment);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argComment	string	value

Returns: int

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

Rename

No description yet.

int Rename(string argOldName, string argNewName);

Parameter	Type	Passing
argOldName	string	value
argNewName	string	value

Returns: int

Resolve

No description yet.

int Resolve(IVcsFileNames argFileNames);
int Resolve(object argFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value

Returns: int

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

Restore

No description yet.

string Restore(IVcsFileNames argFileNames, IVcsFileNames argRestoredFilenames);
string Restore(object argFileNames, object argRestoredFilenames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argRestoredFilenames	IVcsFileNames	value

Returns: string

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

Revert

No description yet.

string Revert(IVcsFileNames argFileNames);
string Revert(object argFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value

Returns: string

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

RevertEx

No description yet.

string RevertEx(IVcsFileNames argFileNames, out IVcsFileNames argReverterFileNames);
string RevertEx(object argFileNames, out IVcsFileNames argReverterFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argReverterFileNames	IVcsFileNames	out

Returns: string

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

RunVcs

No description yet.

int RunVcs(IVcsFileNames argFileNames);
int RunVcs(object argFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value

Returns: int

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

SaveToFile

No description yet.

void SaveToFile(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: nothing (void)

SupportsCommand

No description yet.

bool SupportsCommand(TVcsCommand argCommand, string argFileName);
bool SupportsCommand(int argCommand, string argFileName);

Parameter	Type	Passing
argCommand	TVcsCommand	value
argFileName	string	value

Returns: bool

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

SwitchTo

No description yet.

void SwitchTo(IVcsProject argTargetVcsProject, string argTargetRepositoryPath);
void SwitchTo(object argTargetVcsProject, string argTargetRepositoryPath);

Parameter	Type	Passing
argTargetVcsProject	IVcsProject	value
argTargetRepositoryPath	string	value

Returns: nothing (void)

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

SwitchTo_2

No description yet.

void SwitchTo_2(IVcsProject argTargetVcsProject, string argTargetRepositoryPath, IStrings argFilesToMigrate);
void SwitchTo_2(object argTargetVcsProject, string argTargetRepositoryPath, object argFilesToMigrate);

Parameter	Type	Passing
argTargetVcsProject	IVcsProject	value
argTargetRepositoryPath	string	value
argFilesToMigrate	IStrings	value

Returns: nothing (void)

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

Unlock

No description yet.

int Unlock(IVcsFileNames argFileNames);
int Unlock(object argFileNames);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value

Returns: int

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

Update

No description yet.

int Update(IVcsFileNames argFileNames, bool argForce);
int Update(object argFileNames, bool argForce);

Parameter	Type	Passing
argFileNames	IVcsFileNames	value
argForce	bool	value

Returns: int

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

Returned by

IVcsManager.CreateVcsProject, IVcsProvider.CreateProject

Accepted by

IEDesignData_VcsBasedProjectActions.AddProjectFolderToVCS, IEDesignData_VcsBasedProjectActions.AddProjectToVCS, IEDesignData_VcsBasedProjectActions.AddProjectToVCSNoUI, IEDesignData_VcsBasedProjectActions.CommitProject, IVcsBackgroundThread.ReportStatus, IVcsBasedProjectCommands.AddProjectFolderToVCS, IVcsBasedProjectCommands.AddProjectToVCSNoUI, IVcsBasedProjectCommands.CommitProject, IVcsDesignVault.Import, IVcsDesignVault.Initialize, IVcsManager.BackgroundGetRevisions, IVcsManager.BackgroundGetStatus, IVcsManager.BackgroundGetStatusString, IVcsManager.CommitInteractively, IVcsManager.GetDeletedFileList, IVcsManager.GetLocationInRepository, IVcsManager.GetRevisions, IVcsManager.GetStatus, IVcsManager.GetStatusString, IVcsManager.UpdateInteractively