SetSingleEditWorkspaceAsync(Project,Datastore) Method

In This Topic

Start a single edit workspace session using the specified datastore.

Syntax

C#
Visual Basic (Declaration)

public static Task<bool> SetSingleEditWorkspaceAsync( 
   Project project,
   Datastore datastore
)

Public Overloads Shared Function SetSingleEditWorkspaceAsync( _
   ByVal project As Project, _
   ByVal datastore As Datastore _
) As Task(Of Boolean)

Parameters

project
datastore: The datastore to edit.

Return Value

A task representing a value indicating if the edit session was started.

Exceptions

Exception	Description
System.InvalidOperationException	The project is not configured for editing single workspaces.
System.InvalidOperationException	A workspace is already being edited and has pending edits. Save or discard these edits first.
System.InvalidOperationException	A workspace is already being edited. Stop editing this workspace first.

Remarks

This method can only be used when EditingOptions.EnableEditingFromEditTab and EditingOptions.IsSingleWorkspaceEditSession are true. If the settings are not set then an System.InvalidOperationException will be thrown.

Use this method for editing a file, memory, mobile or other non enterprise geodatabase. Use SetSingleEditWorkspaceAsync(Project,DatastoreConfiguration) for editing an enterprise geodatabase.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.6 or higher.

Reference

EditingProjectExtender Class
EditingProjectExtender Members
Overload List

Send feedback