IEDMS_VaultManager interface

No description yet.

public interface IEDMS_VaultManager

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
AddVault	void
ConfigureInstalledVaults	void
CreateVault	IEDMS_Vault
DiscoverVaultsOnLAN	void
GetEnterpriseVault	IEDMS_Vault
GetFirstEnterpriseVault	IEDMS_Vault
GetInstalledVault	IEDMS_Vault
GetInstalledVaultByGUID	IEDMS_Vault
GetInstalledVaultCount	int
RemoveVault	void
VaultConnected	void

AddVault

No description yet.

void AddVault(IEDMS_Vault argVault);
void AddVault(object argVault);

Parameter	Type	Passing
argVault	IEDMS_Vault	value

Returns: nothing (void)

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

ConfigureInstalledVaults

No description yet.

void ConfigureInstalledVaults();

Returns: nothing (void)

CreateVault

No description yet.

IEDMS_Vault CreateVault(string argVaultTypeID, bool argEnabled, string argParameters);

Parameter	Type	Passing
argVaultTypeID	string	value
argEnabled	bool	value
argParameters	string	value

Returns: IEDMS_Vault

Extension method of IEDMS_VaultManagerHelper (using DXP;).

DiscoverVaultsOnLAN

No description yet.

void DiscoverVaultsOnLAN(bool argWait);

Parameter	Type	Passing
argWait	bool	value

Returns: nothing (void)

GetEnterpriseVault

No description yet.

IEDMS_Vault GetEnterpriseVault();

Returns: IEDMS_Vault

Extension method of IEDMS_VaultManagerHelper (using DXP;).

GetFirstEnterpriseVault

No description yet.

IEDMS_Vault GetFirstEnterpriseVault();

Returns: IEDMS_Vault

Extension method of IEDMS_VaultManagerHelper (using DXP;).

GetInstalledVault

No description yet.

IEDMS_Vault GetInstalledVault(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IEDMS_Vault

Extension method of IEDMS_VaultManagerHelper (using DXP;).

Examples: Extension_GetVaultFolder, Extension_PartChoice, Extension_PlaceComponentFromVault, Extension_PlaceDeviceSheet, Extension_PortalUserInfo

GetInstalledVaultByGUID

No description yet.

IEDMS_Vault GetInstalledVaultByGUID(string argGUID);

Parameter	Type	Passing
argGUID	string	value

Returns: IEDMS_Vault

Extension method of IEDMS_VaultManagerHelper (using DXP;).

GetInstalledVaultCount

No description yet.

int GetInstalledVaultCount();

Returns: int

Examples: Extension_PartChoice, Extension_PortalUserInfo

RemoveVault

No description yet.

void RemoveVault(IEDMS_Vault argVault);
void RemoveVault(object argVault);

Parameter	Type	Passing
argVault	IEDMS_Vault	value

Returns: nothing (void)

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

VaultConnected

No description yet.

void VaultConnected(string argVaultGUID);

Parameter	Type	Passing
argVaultGUID	string	value

Returns: nothing (void)

Returned by

Utils.GetVaultManager

Examples

Used in the SDK examples: Extension_GetVaultFolder, Extension_PartChoice, Extension_PlaceComponentFromVault, Extension_PlaceDeviceSheet, Extension_PortalUserInfo.