BCVaultLink Class

BCVaultLink Class

Represents an object that manages the connection to a vault.

Inheritance Hierarchy

SystemObject
BlueCieloECM.InnoCielo.MeridianDisposableObject
BlueCieloECM.InnoCielo.Meridian.ClientBCVaultLink

Namespace: BlueCieloECM.InnoCielo.Meridian.Client
Assembly: BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 4.0.0.0 (4.0.19.0)

Syntax

C++

Copy

public class BCVaultLink : DisposableObject

Public Class BCVaultLink
	Inherits DisposableObject

public ref class BCVaultLink : public DisposableObject

type BCVaultLink =  
    class
        inherit DisposableObject
    end

The BCVaultLink type exposes the following members.

Constructors

	Name	Description
	BCVaultLink	Initializes a new instance of the BCVaultLink class.
	BCVaultLink(BCRepository)	Initializes a new instance of the BCVaultLink class.

Top

Properties

	Name	Description
	BaseLineDisplayName	Gets or sets the display name of the selected baseline.
	BaseLineID	Gets or sets the ID property value of the selected baseline.
	DataStoreName	Gets or sets the name of the selected data store.
	DateTimeUTC	Gets or sets the selected date value of History mode.
	IsBaseline	Gets a value indicating whether a baseline was used to select a moment in history.
	IsDisposed	Gets a value indicating whether the object has been disposed of. (Inherited from DisposableObject.)
	IsWorkMode	Gets a value indicating whether the vault is in writable mode.
	IsWorkPackage	Gets a value indicating whether the work area is selected.
	MachineName	Gets or sets the name of the selected server machine.
	SectionAddress	Gets or sets the address of the selected section in format: "\\{MachineName}\{DataStoreName}\{VaultName}".
	UnderlyingObject	Gets the underlying wrapped object. (Inherited from DisposableObject.)
	VaultDisplayName	Gets or sets the display name of the selected vault.
	VaultName	Gets or sets the name of the selected vault.
	WorkMode	Gets or sets a value indicating whether the vault is in writable mode.
	WorkPackageDisplayName	Gets or sets the display name of the selected work area.
	WorkPackageID	Gets or sets the ID property value of the selected work area.

Top

Methods

	Name	Description
	CreateVault	Returns an instance of the BCRepository class that represents a connection to the server. The connection has been opened using the information set on the BCVaultLink. The application should call Dispose to release the repository instance.
	DateTimeAsText	Returns a human-friendly string representation of the moment of time the vault was opened. It can be a baseline name, or a formatted date. For the current moment it may be the word "Current" (localized).
	DateTimeAsText(Boolean)	Returns a string representation of the moment of time the vault was opened. It can be a baseline name, or a formatted date. For the current moment it may be the word "Current" (localized).
	Dispose	Releases the underlying wrapped object explicitly. (Inherited from DisposableObject.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LoadFromFile	Loads connection settings from a file created with SaveToFile(String).
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnDispose	The method is called on Dispose. (Overrides DisposableObjectOnDispose.)
	SaveToFile	Stores connection settings to the file.
	ThrowIfDisposed	Throws the ObjectDisposedException exception if the underlying object has been disposed. (Inherited from DisposableObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The properties of this object together define a specific context within a specific vault. Applications can use this information to connect to the vault and start a transaction.

Reference

BlueCieloECM.InnoCielo.Meridian.Client Namespace