SimulatorClient Class
Definition
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.
SimulatorClient class that implements ISimulator interface. Note that most methods in this class are not re-entrant.
public ref class SimulatorClient sealed : IDisposable, Microsoft::Windows::Simulator::Client::ISimulator
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("7D87C833-5E9E-453E-A9B0-BE285620EC98")]
public sealed class SimulatorClient : IDisposable, Microsoft.Windows.Simulator.Client.ISimulator
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Runtime.InteropServices.Guid("7D87C833-5E9E-453E-A9B0-BE285620EC98")>]
type SimulatorClient = class
interface ISimulator
interface IDisposable
Public NotInheritable Class SimulatorClient
Implements IDisposable, ISimulator
- Inheritance
-
SimulatorClient
- Attributes
- Implements
Constructors
SimulatorClient() |
Properties
ErrorReportingSettings |
Gets the IErrorReportingSettings for the Simulator session. This is not cached by the Simulator. Caller is responsible for caching and releasing. |
IsStarted |
Gets a value indicating whether the simulator is running or not. |
SessionId |
Gets the id of the session hosted by the Simulator. |
Methods
ActivateApplicationAsync(String, IProcessStartedCompletionRoutine, String) |
Activates an immersive application in the Simulator. |
ActivateApplicationCancelAsync(String) |
Tries to cancel activation of the given application. If successful, the completionRoutine in ActivateApplicationAsync returns with E_ABORT exception in error parameter. |
AllowTakeForeground(Int32) |
Requests the Simulator UI application to allow the given processId to take foreground. |
BringSimulatorToForeground() |
Brings the Simulator UI application to the foreground. |
Dispose() | |
GetCurrentForegroundWindow() |
Gets current foreground window. |
GetRestrictedErrorInfo(String, String, String) |
Maps a restricted reference to the restricted description and any missing capability. |
GetUIProcessId() |
Returns the ProcessId of the Simulator UI application. |
SendRemoteAction(RemoteSessionActionType) |
Sends the specified RemoteSessionActionType to the Simulator session. Currently only RemoteActionType.StartScreen is supported. |
SetCurrentForegroundWindow(Int32) |
Sets the current foreground window. |
StartAsync(ICompletionRoutine, Boolean, Int32) |
Asynchronously starts and logs into the Simulator. |
StartAsyncCancel() |
Cancels an ongoing StartAsync(ICompletionRoutine, Boolean, Int32) operation. |
StartProcessAsync(StartProcessInfo, IProcessStartedCompletionRoutine) |
Starts a process in the Simulator running as the logged in user. The process is always started directly from the executable file (not through the shell). If the process is a console application, it is run without a console window. |
StopAsync(ICompletionRoutine) |
Asynchronously logs out, stops, and shuts down the Simulator. |