IHistoricalWorkspace Interface

Description

The IHistoricalWorkspaceinterface can be used to detect existing historical markers while also providing the functionality to add or remove historical markers from the workspace. This interface can also be leveraged to query existing historical versions on the historical workspace.

Members

	Name	Description
	AddHistoricalMarker	Add a historical marker to this workspace.
	DefaultMarkerName	The marker name which represents the last save or post of the default transactional version.
	FindHistoricalVersionByName	Open a historical version by specifying a historical marker name.
	FindHistoricalVersionByTimeStamp	Open a historical version by specifying a timestamp.
	HistoricalMarkers	An enumerator of all historical markers managed by this workspace.
	RemoveHistoricalMarker	Remove a historical marker from this workspace.

IHistoricalWorkspace.AddHistoricalMarker Method

Add a historical marker to this workspace.

Public Function AddHistoricalMarker ( _
    ByVal Name As String, _
    ByVal tstamp As Object _
) As IHistoricalMarker

public IHistoricalMarker AddHistoricalMarker (
    string Name,
    object tstamp
);

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.`

IHistoricalWorkspace.DefaultMarkerName Property

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

Public ReadOnly Property DefaultMarkerName As String

public string DefaultMarkerName {get;}

Remarks

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

IHistoricalWorkspace.FindHistoricalVersionByName Method

Open a historical version by specifying a historical marker name.

Public Function FindHistoricalVersionByName ( _
    ByVal historicalMarkerName As String _
) As IHistoricalVersion

public IHistoricalVersion FindHistoricalVersionByName (
    string historicalMarkerName
);

Remarks

The FindHistoricalVersionByNamemethod 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.

IHistoricalWorkspace.FindHistoricalVersionByTimeStamp Method

Open a historical version by specifying a timestamp.

Public Function FindHistoricalVersionByTimeStamp ( _
    ByVal tstamp As Object _
) As IHistoricalVersion

public IHistoricalVersion FindHistoricalVersionByTimeStamp (
    object tstamp
);

Remarks

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

IHistoricalWorkspace.HistoricalMarkers Property

An enumerator of all historical markers managed by this workspace.

Public ReadOnly Property HistoricalMarkers As IEnumHistoricalMarker

public IEnumHistoricalMarker HistoricalMarkers {get;}

Remarks

The HistoricalMarkersproperty 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.

IHistoricalWorkspace.RemoveHistoricalMarker Method

Remove a historical marker from this workspace.

Public Sub RemoveHistoricalMarker ( _
    ByVal Name As String _
)

public void RemoveHistoricalMarker (
    string Name
);

Errors Returned

FDO_E_NO_PERMISSION: The user does not have permission to execute the operation.

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.`

Classes that implement IHistoricalWorkspace

Classes	Description