GetHistoricalVersion(String) Method

In This Topic

Gets a HistoricalVersion object with the specified . This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Function GetHistoricalVersion( _
   ByVal markerName As String _
) As HistoricalVersion

public HistoricalVersion GetHistoricalVersion( 
   string markerName
)

Parameters

markerName: The name of the HistoricalVersion to return.

Return Value

The HistoricalVersion that corresponds to .

Exceptions

Exception	Description
System.ArgumentException	The markerName cannot be null or an empty string.
System.InvalidOperationException	The input marker name does not belong to any HistoricalVersion.
ArcGIS.Core.Data.Exceptions.GeodatabaseException	A geodatabase-related exception has occurred.
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run

Example

Switching between versions

{
  // Must be called within QueuedTask.Run
  void ChangeVersions(Geodatabase geodatabase, string toVersionName)
  {
    using (VersionManager versionManager = geodatabase.GetVersionManager())
    {
      VersionBaseType versionBaseType = versionManager.GetCurrentVersionBaseType();

      if (versionBaseType == VersionBaseType.Version)
      {
        Version fromVersion = versionManager.GetCurrentVersion();
        Version toVersion = versionManager.GetVersion(toVersionName);

        // Switch between versions
        MapView.Active.Map.ChangeVersion(fromVersion, toVersion);
      }

      if (versionBaseType == VersionBaseType.HistoricalVersion)
      {
        HistoricalVersion fromHistoricalVersion = versionManager.GetCurrentHistoricalVersion();
        HistoricalVersion toHistoricalVersion = versionManager.GetHistoricalVersion(toVersionName);

        // Switch between historical versions
        MapView.Active.Map.ChangeVersion(fromHistoricalVersion, toHistoricalVersion);
      }

      // Switch from HistoricalVersion to Version and vice-versa 
      // MapView.Active.Map.ChangeVersion(fromHistoricalVersion, toVersion);
      // MapView.Active.Map.ChangeVersion(fromVersion, toHistoricalVersion);
    }
  }
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

VersionManager Class
VersionManager Members
Overload List

Send feedback