CreateHistoricalVersion Method

In This Topic

Creates a new HistoricalVersion. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Function CreateHistoricalVersion( _
   ByVal historicalVersionDescription As HistoricalVersionDescription _
) As HistoricalVersion

public HistoricalVersion CreateHistoricalVersion( 
   HistoricalVersionDescription historicalVersionDescription
)

Parameters

historicalVersionDescription: The HistoricalVersionDescription that specifies what the historical version should look like.

Exceptions

Exception	Description
System.ArgumentNullException	historicalVersionDescription is null.
System.ArgumentException	The HistoricalVersionDescription.Name value in historicalVersionDescription is null or an empty string.
System.NotSupportedException	The underlying data store is a Feature Service Database, which does not support creating HistoricalVersions.
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

Creating a Historical version

{
  // Must be called within QueuedTask.Run
  HistoricalVersion CreateHistoricalVersion(Geodatabase geodatabase, string versionName)
  {
    using (VersionManager versionManager = geodatabase.GetVersionManager())
    {
      HistoricalVersionDescription historicalVersionDescription =
        new HistoricalVersionDescription(versionName, DateTime.Now);
      HistoricalVersion historicalVersion =
        versionManager.CreateHistoricalVersion(historicalVersionDescription);

      return historicalVersion;
    }
  }
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

VersionManager Class
VersionManager Members

Send feedback