Interface IHistoricalWorkspace

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll
[Guid("39C92BB1-28E4-4333-8FBC-4E32FB50AE63")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IHistoricalWorkspace

Properties

DefaultMarkerName

The marker name which represents the last save or post of the default transactional version.

string DefaultMarkerName { get; }

Property Value

string

Remarks

The DefaultMarkerName property returns a string which represents the last save or post of the default transactional version.

HistoricalMarkers

An enumerator of all historical markers managed by this workspace.

IEnumHistoricalMarker HistoricalMarkers { get; }

Property Value

IEnumHistoricalMarker

Remarks

The HistoricalMarkers property returns an enumeration of the historical markers that exist on the current historical workspace. It can be used to populate an enumeration of historical markers that have been created.

Methods

AddHistoricalMarker(string, object)

Add a historical marker to this workspace.

IHistoricalMarker AddHistoricalMarker(string Name, object tstamp)

Parameters

Name string
tstamp object

Returns

IHistoricalMarker

Remarks

The AddHistoricalMarker method is used to add a historical marker to the workspace. Historical markers are used to represent specific moments in the database which reference a date and time. They can then be used as a mechanism to easily recognize specific database's moment or events.
For example, an organization might create historical markers to reflect quarters of a fiscal year. This will then allow users the ability to quickly change their historical versions to each moment using a historical marker.
Historical markers are case sensitive. All users have privileges to create historical markers. Historical marker names are limited to sixty-four characters. Adding a historical marker modifies the geodatabase's system tables and explicitly performs a database commit, and should therefore not be done during an edit session.

FindHistoricalVersionByName(string)

Open a historical version by specifying a historical marker name.

IHistoricalVersion FindHistoricalVersionByName(string historicalMarkerName)

Parameters

historicalMarkerName string

Returns

IHistoricalVersion

Remarks

The FindHistoricalVersionByName method can be used to find a historical version by using an existing historical marker. The input string used to locate the historical marker is case sensitive. The "DEFAULT" historical marker is unique and is not case sensitive.

FindHistoricalVersionByTimeStamp(object)

Open a historical version by specifying a timestamp.

IHistoricalVersion FindHistoricalVersionByTimeStamp(object tstamp)

Parameters

tstamp object

Returns

IHistoricalVersion

Remarks

The FindHistoricalVersionByTimeStamp method can be used to find a specific historical version that exists in the historical workspace by specifying the time stamp.

RemoveHistoricalMarker(string)

Remove a historical marker from this workspace.

void RemoveHistoricalMarker(string Name)

Parameters

Name string

Remarks

The RemoveHistoricalMarker method removes the specified historical marker from the workspace.
Removing a historical marker modifies the geodatabase's system tables and explicitly performs a database commit, and should therefore not be done during an edit session.
The DEFAULT historical marker can not be deleted.