Skip to main content

Component Plug-In SDK 2026 R1

Method OpenLocalEditSessionForComponentAsync

Last update: 19.06.2026

Namespace: Phoenix.ComponentAPI
Assembly: Phoenix.ComponentAPI.dll

OpenLocalEditSessionForComponentAsync(IHarnessRunnerSession)

Opens up the pacz for the given IHarnessRunnerSession for editing locally. Typically used to create metadata editors in the main OEM UI. No IHarnessBuilderUISession may be open on this runner when calling this method.

Task<IHarnessLocalEditSession> OpenLocalEditSessionForComponentAsync(IHarnessRunnerSession session)

Parameters

session IHarnessRunnerSession

The session to instantiate a local edit session for. The session must have been created by this client object. It is illegal to call this function more than once without calling Dispose on the returned IHarnessLocalEditSession first.

Returns

Task<IHarnessLocalEditSession>

A task that returns a new IHarnessLocalEditSession object

Exceptions

InvalidOperationException

If a builder or local edit session is already open for the given runner session

Connect with Ansys