Skip to main content
View as Markdown

ILocalHistoryManager interface

No description yet.

public interface ILocalHistoryManager

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties​

PropertyTypeAccessDescription
AddAutoSavesboolget; set
GlobalRepositoryPathstringget; set
StartPurgingAfterintget; set

AddAutoSaves​

No description yet.

bool GetAddAutoSaves();
void SetAddAutoSaves(bool argValue);

Type: bool · Access: read/write

GlobalRepositoryPath​

No description yet.

string GetGlobalRepositoryPath();
void SetGlobalRepositoryPath(string argValue);

Type: string · Access: read/write

StartPurgingAfter​

No description yet.

int GetStartPurgingAfter();
void SetStartPurgingAfter(int argValue);

Type: int · Access: read/write

Methods​

MethodReturnsDescription
Addint
ApplyLabelbool
CopyLabelbool
CopyVersionbool
Deletebool
DisableLocalHistoryvoid
EnableLocalHistoryvoid
GetGlobalRepositoryPathNotExpandedstring
GetHistoryIDocumentBackups
GetHistoryPathForFilestring
GetInfobool
Purgevoid
RevertToLabelbool
RevertToVerbool

Add​

No description yet.

int Add(string argFileName, string argLabel);
ParameterTypePassing
argFileNamestringvalue
argLabelstringvalue

Returns: int

ApplyLabel​

No description yet.

bool ApplyLabel(string argFileName, int argVersion, string argLabel);
ParameterTypePassing
argFileNamestringvalue
argVersionintvalue
argLabelstringvalue

Returns: bool

CopyLabel​

No description yet.

bool CopyLabel(string argFileName, string argLabel, string argDestName);
ParameterTypePassing
argFileNamestringvalue
argLabelstringvalue
argDestNamestringvalue

Returns: bool

CopyVersion​

No description yet.

bool CopyVersion(string argFileName, int argVersion, string argDestName);
ParameterTypePassing
argFileNamestringvalue
argVersionintvalue
argDestNamestringvalue

Returns: bool

Delete​

No description yet.

bool Delete(string argFileName, int argVersion, bool argDelLabel);
ParameterTypePassing
argFileNamestringvalue
argVersionintvalue
argDelLabelboolvalue

Returns: bool

DisableLocalHistory​

No description yet.

void DisableLocalHistory();

Returns: nothing (void)

EnableLocalHistory​

No description yet.

void EnableLocalHistory();

Returns: nothing (void)

GetGlobalRepositoryPathNotExpanded​

No description yet.

string GetGlobalRepositoryPathNotExpanded();

Returns: string

GetHistory​

No description yet.

IDocumentBackups GetHistory(string argFileName);
ParameterTypePassing
argFileNamestringvalue

Returns: IDocumentBackups

Extension method of ILocalHistoryManagerHelper (using DXP;).

GetHistoryPathForFile​

No description yet.

string GetHistoryPathForFile(string argFileName);
ParameterTypePassing
argFileNamestringvalue

Returns: string

GetInfo​

No description yet.

bool GetInfo(string argHistoryFileName, ref string argFileName, ref string argLabel, ref int argVersion);
ParameterTypePassing
argHistoryFileNamestringvalue
argFileNamestringref
argLabelstringref
argVersionintref

Returns: bool

Purge​

No description yet.

void Purge(string argFileName);
ParameterTypePassing
argFileNamestringvalue

Returns: nothing (void)

RevertToLabel​

No description yet.

bool RevertToLabel(string argFileName, string argLabel);
ParameterTypePassing
argFileNamestringvalue
argLabelstringvalue

Returns: bool

RevertToVer​

No description yet.

bool RevertToVer(string argFileName, int argVersion);
ParameterTypePassing
argFileNamestringvalue
argVersionintvalue

Returns: bool

Returned by​

IDXPWorkSpace.DM_LocalHistoryManager, IWorkspace.DM_LocalHistoryManager