RemoteAutomationClientSession Class

Reference

Definition

Namespace:: Windows.UI.UIAutomation.Core

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a UI Automation client session for a remote application.

public ref class RemoteAutomationClientSession sealed

/// [Windows.Foundation.Metadata.Activatable(Windows.UI.UIAutomation.Core.IRemoteAutomationClientSessionFactory, 131072, "Windows.UI.UIAutomation.UIAutomationContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.UI.UIAutomation.UIAutomationContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class RemoteAutomationClientSession final

[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.UIAutomation.Core.IRemoteAutomationClientSessionFactory), 131072, "Windows.UI.UIAutomation.UIAutomationContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.UI.UIAutomation.UIAutomationContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class RemoteAutomationClientSession

Public NotInheritable Class RemoteAutomationClientSession

Inheritance: Object Platform::Object IInspectable RemoteAutomationClientSession

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 11 (introduced in 10.0.22000.0)
API contract	Windows.UI.UIAutomation.UIAutomationContract (introduced in v2.0)

Remarks

This class is used by a host application (such as the remote desktop app running on the local machine) to plug in and implement named pipe sharing with a remote session (container or network). The host application would implement ConnectionRequested/Disconnected callbacks to share the named pipe, then start/stop the client session to enable/disable those callbacks.

Constructors

RemoteAutomationClientSession(String, Guid)	Initializes a new instance of the RemoteAutomationClientSession class using the supplied parameters.
RemoteAutomationClientSession(String)	Initializes a new instance of the RemoteAutomationClientSession class using the supplied name.

Properties

SessionId

Gets the unique identifier of the RemoteAutomationClientSession.

Methods

CreateWindowAsync(UInt64, UInt32, Object)	Creates a parent-child relationship between a parent AutomationElement and a child remote window.
Start()	Begins the RemoteAutomationClientSession, enabling a UI Automation client to create connections to the remote session.
Stop()	Terminates the current RemoteAutomationClientSession.

Events

ConnectionRequested	Occurs when a connection to a remote system is requested.
Disconnected	Occurs when the RemoteAutomationClientSession is disconnected.

Applies to

Share via