Microsoft.Windows.Simulator.Client

Defines the completion routine for asynchronous Simulator operations.

Called when the Simulator finishes an asynchronous operation.

The exception that describes any error that occurs when it processes the Simulator request or null if there was no error. describes any error encountered when processing the request.

Defines the completion routine when or finishes.

Called when or finishes starting the requested process.

The id of the process that was started or 0 if there was an error. The exception that describes any error that occurs when you start the Simulator or null if there was no error. describes any error encountered when processing the request.

Defines a Windows simulator for running, debugging, profiling, and testing AppContainer applications. There is at most one simulator per user session. Each instance of will connect to the same running simulator.

Activates an AppContainer application in the Simulator.

The AppUserModelId that describes the AppContainer application to start. An implementation of the completion routine to be called when activation finishes. Returns the request id that can be used to call ActivateApplicationCancelAsync. Thrown if there is any asynchronous operation already in progress. Or any other error case in the Simulator.

Tries to cancel activation of the given application. If successful, the completionRoutine in ActivateApplicationAsync returns with E_ABORT exception in error parameter.

RequestId that was returned by ActivateApplicationAsync.

Requests the Simulator UI application to allow the given processId to take foreground.

Process Id that is requesting to take foreground.

Brings the Simulator UI application to the foreground.

Gets the IErrorReportingSettings for the Simulator session. This is not cached by the Simulator. Caller is responsible for caching and releasing.

Returns .

Gets current foreground window.

A cookie representation of window.

Maps a restricted reference to the restricted description and any missing capability.

Restricted Reference. Restricted Description obtained from Restricted Reference. Represents any missing capability.

Returns the ProcessId of the Simulator UI application.

Returns .

Gets a value indicating whether the simulator is running or not.

Returns .

Sends the specified to the Simulator session. Currently only RemoteActionType.StartScreen is supported.

The type of remote action to send to the Simulator session. Thrown if the value of is not RemoteActionType.StartScreen.

Gets the id of the session hosted by the Simulator.

Returns .

Sets the current foreground window.

A cookie retrieved using GetCurrentForegroundWindow.

Asynchronously starts and logs into the Simulator.

An implementation of the completion routine to be called when the Start operation finishes. Indicate whether Simulator should be started as minimized. The locale to be passed into Simulator. Thrown if there is any asynchronous operation already in progress. Or any other error case in the Simulator. Thrown if the Start operation was canceled.

Cancels an ongoing operation.

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.

The set of parameters that are used to start the process in the Simulator. An implementation of the completion routine to be called when activation finishes. Thrown if there is any asynchronous operation already in progress. Or any other error case in the Simulator.

Asynchronously logs out, stops, and shuts down the Simulator.

An implementation of the completion routine to be called when the Stop operation finishes. Thrown if there is any asynchronous operation already in progress. Or any other error case in the Simulator.

Returns the HResult in case if the exception wraps a COMException

Returns .

Returns a custom error code (See SimulatorErrorCodes)

Returns .

Specifies the types of remote actions for the Simulator session. The value of each RemoteActionType matches the values in IRemoteDesktopClientActions::RemoteActionType.

This exception is reported in ICompletionRoutine when an async action has been canceled.

SimulatorClient class that implements ISimulator interface. Note that most methods in this class are not re-entrant.

Activates an immersive application in the Simulator.

The AppUserModelId that describes the immersive application to start. An implementation of the completion routine to be called when activation is completed. Returns the request id that can be used to call ActivateApplicationCancelAsync. Thrown if there is any asynchronous operation already in progress. Or any other error case in the Simulator.

Tries to cancel activation of the given application. If successful, the completionRoutine in ActivateApplicationAsync returns with E_ABORT exception in error parameter.

RequestId that was returned by ActivateApplicationAsync.

Requests the Simulator UI application to allow the given processId to take foreground.

Process Id that is requesting to take foreground.

Brings the Simulator UI application to the foreground.

Gets the IErrorReportingSettings for the Simulator session. This is not cached by the Simulator. Caller is responsible for caching and releasing.

Returns .

Gets current foreground window.

A cookie representation of window.

Maps a restricted reference to the restricted description and any missing capability.

Restricted Reference. Restricted Description obtained from Restricted Reference. Represents any missing capability.

Returns the ProcessId of the Simulator UI application.

Returns .

Gets a value indicating whether the simulator is running or not.

Returns .

Sends the specified to the Simulator session. Currently only RemoteActionType.StartScreen is supported.

The type of remote action to send to the Simulator session. Thrown if the value of is not RemoteActionType.StartScreen.

Gets the id of the session hosted by the Simulator.

Returns .

Sets the current foreground window.

A cookie retrieved using GetCurrentForegroundWindow.

Asynchronously starts and logs into the Simulator.

An implementation of the completion routine to be called when the Start operation finishes. Indicate whether Simulator should be started as minimized. The locale to be passed into Simulator. Thrown if there is any asynchronous operation already in progress. Or any other error case in the Simulator. Thrown if the Start operation was canceled.

Cancels an ongoing operation.

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.

The set of parameters that are used to start the process in the Simulator. An implementation of the completion routine to be called when activation finishes. Thrown if there is any asynchronous operation already in progress. Or any other error case in the Simulator.

Asynchronously logs out, stops, and shuts down the Simulator.

An implementation of the completion routine to be called when the Stop operation finishes. Thrown if there is any asynchronous operation already in progress. Or any other error case in the Simulator.

Another user on this computer is running Simulator, cannot start Simulator.

AppContainer Application Id is Null or Empty/Whitespace String

Application not found

You cannot call any operation on Simulator if it is not running

Can not get Simulator ProcessID, see inner exception for more information.

Failed to obtain the ErrorReportingSettings object in remote RDP session

Could not find InstallPath in registry, Simulator installation might be corrupted.

When Simulator is canceling previous operation or still running another operation, it cannot execute current operation

Process File Name is Null or Empty/Whitespace string

FileNotFound exception from remote server

Simulator closed or crashed.

An instance of Simulator is running under a difference security context.

Simulator is taking too long to start

Unable to create Simulator Service in remote RDP session

Unable to obtain current foreground window.

The Simulator is unable to send the requested action to the Simulator session.

Unable to set foreground window.

Unable to take foreground while activating application.

Any other error not known.

Trying to run Simulator on an unsupported operating system.

Represents errors that occur while you are using the simulator.

Returns . Returns .

Specifies a set of values that are used to start a process in the Simulator.

Gets or sets the command line arguments to use when it starts the application.

Gets or sets the environment variables to use when it starts the application. The environment variables are represented as a null-terminated block of null-terminated strings.

Gets or sets the file name of the application to start.

Gets or sets the working directory to use when it starts the application.