Skip to main content
View as Markdown

IEDesignData_VcsBasedProjectActions interface

No description yet.

public interface IEDesignData_VcsBasedProjectActions

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods​

MethodReturnsDescription
AddProjectFolderToVCSvoid
AddProjectToServicebool
AddProjectToServiceExbool
AddProjectToVCSbool
AddProjectToVCSNoUIbool
AddVCSRepositorybool
CanAddProjectToVCSbool
CheckOutvoid
CloneDialogbool
CommitProjectvoid
ConvertDialogbool
ConvertDialogExbool
DeleteProjectFromServicevoid
FindDesignVaultByNameIVcsDesignVault
GetDesignVaultByNameIVcsDesignVault
GetRepositoryForManagedProjectsPresentbool
LinkDialogbool
OpenDialogbool
SelectRepositoryPathbool

AddProjectFolderToVCS​

No description yet.

void AddProjectFolderToVCS(IVcsProject argVCSProject, IVcsDesignVault argDesignVault, string argProjectFileName, string argProjectVCSPath);
void AddProjectFolderToVCS(object argVCSProject, object argDesignVault, string argProjectFileName, string argProjectVCSPath);
ParameterTypePassing
argVCSProjectIVcsProjectvalue
argDesignVaultIVcsDesignVaultvalue
argProjectFileNamestringvalue
argProjectVCSPathstringvalue

Returns: nothing (void)

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

AddProjectToService​

No description yet.

bool AddProjectToService(string argHRID, string argProjectType, string argManagedRepositoryGUID, string argDescription, string argRepositoryPath, out string argProjectGUID, out string argErrorMessage);
ParameterTypePassing
argHRIDstringvalue
argProjectTypestringvalue
argManagedRepositoryGUIDstringvalue
argDescriptionstringvalue
argRepositoryPathstringvalue
argProjectGUIDstringout
argErrorMessagestringout

Returns: bool

AddProjectToServiceEx​

No description yet.

bool AddProjectToServiceEx(ref string argParameters, out string argErrorMessage);
ParameterTypePassing
argParametersstringref
argErrorMessagestringout

Returns: bool

AddProjectToVCS​

No description yet.

bool AddProjectToVCS(IVcsProject argVCSProject, IVcsDesignVault argDesignVault, string argProjectFileName, string argProjectVCSPath, string argComment);
bool AddProjectToVCS(object argVCSProject, object argDesignVault, string argProjectFileName, string argProjectVCSPath, string argComment);
ParameterTypePassing
argVCSProjectIVcsProjectvalue
argDesignVaultIVcsDesignVaultvalue
argProjectFileNamestringvalue
argProjectVCSPathstringvalue
argCommentstringvalue

Returns: bool

The first overload is an extension method of IEDesignData_VcsBasedProjectActionsHelper (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);
ParameterTypePassing
argVCSProjectIVcsProjectvalue
argDesignVaultIVcsDesignVaultvalue
argFileNamesIVcsFileNamesvalue
argProjectstringvalue
argProjectVCSPathstringvalue
argCommentstringvalue

Returns: bool

The first overload is an extension method of IEDesignData_VcsBasedProjectActionsHelper (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);
ParameterTypePassing
argRepositoryNamestringvalue
argRepositoryPathstringvalue
argManagedRepositoryGUIDstringvalue
argWorkingCopyDirstringvalue
argProviderTypeTProviderTypevalue
argCreateKindTCreateKindvalue
argRepositoryTypeTRepositoryTypevalue

Returns: bool

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

CanAddProjectToVCS​

No description yet.

bool CanAddProjectToVCS(IVcsDesignVault argDesignVault, string argProject, string argProjectVCSPath, out string argMessage);
bool CanAddProjectToVCS(object argDesignVault, string argProject, string argProjectVCSPath, out string argMessage);
ParameterTypePassing
argDesignVaultIVcsDesignVaultvalue
argProjectstringvalue
argProjectVCSPathstringvalue
argMessagestringout

Returns: bool

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

CheckOut​

No description yet.

void CheckOut(IVcsDesignVault argVcsDesignVault, string argProjectVCSPath, string argWorkingCopyDir, string argRelPath, int argRevisionId);
void CheckOut(object argVcsDesignVault, string argProjectVCSPath, string argWorkingCopyDir, string argRelPath, int argRevisionId);
ParameterTypePassing
argVcsDesignVaultIVcsDesignVaultvalue
argProjectVCSPathstringvalue
argWorkingCopyDirstringvalue
argRelPathstringvalue
argRevisionIdintvalue

Returns: nothing (void)

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

CloneDialog​

No description yet.

bool CloneDialog(IEDMS_ManagedProject argSourceProject, out IVcsDesignVault argVcsDesignVault, out string argProjectName, out string argWorkingCopyDir, out string argProjectRepositoryPath, out string argManagedProjectGUID, out string argProjectType, out IInterfaces argProjectParameters);
bool CloneDialog(object argSourceProject, out IVcsDesignVault argVcsDesignVault, out string argProjectName, out string argWorkingCopyDir, out string argProjectRepositoryPath, out string argManagedProjectGUID, out string argProjectType, out IInterfaces argProjectParameters);
ParameterTypePassing
argSourceProjectIEDMS_ManagedProjectvalue
argVcsDesignVaultIVcsDesignVaultout
argProjectNamestringout
argWorkingCopyDirstringout
argProjectRepositoryPathstringout
argManagedProjectGUIDstringout
argProjectTypestringout
argProjectParametersIInterfacesout

Returns: bool

The first overload is an extension method of IEDesignData_VcsBasedProjectActionsHelper (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);
ParameterTypePassing
argVCSProjectIVcsProjectvalue
argProjectstringvalue

Returns: nothing (void)

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

ConvertDialog​

No description yet.

bool ConvertDialog(string argProjectName, out IVcsDesignVault argVcsDesignVault);
ParameterTypePassing
argProjectNamestringvalue
argVcsDesignVaultIVcsDesignVaultout

Returns: bool

ConvertDialogEx​

No description yet.

bool ConvertDialogEx(ref string argParameters, out IVcsDesignVault argVcsDesignVault);
ParameterTypePassing
argParametersstringref
argVcsDesignVaultIVcsDesignVaultout

Returns: bool

DeleteProjectFromService​

No description yet.

void DeleteProjectFromService(string argProjectGUID, out string argErrorMessage);
ParameterTypePassing
argProjectGUIDstringvalue
argErrorMessagestringout

Returns: nothing (void)

FindDesignVaultByName​

No description yet.

IVcsDesignVault FindDesignVaultByName(string argName);
ParameterTypePassing
argNamestringvalue

Returns: IVcsDesignVault

Extension method of IEDesignData_VcsBasedProjectActionsHelper (using DXP;).

GetDesignVaultByName​

No description yet.

IVcsDesignVault GetDesignVaultByName(string argName);
ParameterTypePassing
argNamestringvalue

Returns: IVcsDesignVault

Extension method of IEDesignData_VcsBasedProjectActionsHelper (using DXP;).

GetRepositoryForManagedProjectsPresent​

No description yet.

bool GetRepositoryForManagedProjectsPresent();

Returns: bool

LinkDialog​

No description yet.

bool LinkDialog(out IVcsDesignVault argVcsDesignVault, out string argProjectName, out string argWorkingCopyDir, out string argProjectRepositoryPath, out string argManagedProjectGUID, out string argProjectType);
ParameterTypePassing
argVcsDesignVaultIVcsDesignVaultout
argProjectNamestringout
argWorkingCopyDirstringout
argProjectRepositoryPathstringout
argManagedProjectGUIDstringout
argProjectTypestringout

Returns: bool

OpenDialog​

No description yet.

bool OpenDialog(out IVcsDesignVault argVcsDesignVault, out string argProjectName, out string argWorkingCopyDir, out string argProjectRepositoryPath, out string argManagedProjectGUID, out string argProjectType);
ParameterTypePassing
argVcsDesignVaultIVcsDesignVaultout
argProjectNamestringout
argWorkingCopyDirstringout
argProjectRepositoryPathstringout
argManagedProjectGUIDstringout
argProjectTypestringout

Returns: bool

SelectRepositoryPath​

No description yet.

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

Returns: bool

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

Returned by​

IEDesignDataInterface.GetVcsBasedProjectActions