SimulationManager.GetStatusAsync Method

Gets the status of a simulation asynchronously.

Syntax

public:
static IAsyncOperation<IVectorView<SimulationStatus>>^ GetStatusAsync()  

Return value

Type: IAsyncOperation<IVectorView<SimulationStatus» 

Returns a list of SimulationStatus structures that describe which simulations are running. Each SimulationStatus structure in the list includes information about the type and profile of a given simulation. If an empty list is returned, no simulations are running. Note that currently, only one simulation is allowed to be running at any given time so the list of SimulationStatus structures should include at most one element.

Example

var XtfSimulationManager = Microsoft.Xbox.Tools.ConsoleExtensions.SimulationManager;      
XtfSimulationManager.getStatusAsync().then(

  function complete(result) {
      // Handle success here
      writeLog("SimulationManager.getStatusAsync succeeded");

      if (result.size == 0) {
          writeLog("No simulations are currently running");
      } else {

          result.forEach(
              // Display information for each simulation that is running
              function displaySimStatusRecord(simStatus) {
                  writeLog(simStatus.profile.toString());
                  writeLog(simStatus.type.toString());
              }
          )
      }

  }.bind(this),

  function error(e) {
      // Handle error here 
      writeError("SimulationManager.getStatusAsync error: ", e);
  }.bind(this)

);  

C++

Microsoft::Xbox::Tools::ConsoleExtensions::SimulationManager::GetStatusAsync()->Completed =
ref new Windows::Foundation::AsyncOperationCompletedHandler<Windows::Foundation::Collections::IVectorView<Microsoft::Xbox::Tools::ConsoleExtensions::SimulationStatus>^ >
( [ this ] ( Windows::Foundation::IAsyncOperation<Windows::Foundation::Collections::IVectorView<Microsoft::Xbox::Tools::ConsoleExtensions::SimulationStatus>^ >^ action, Windows::Foundation::AsyncStatus asyncStatus )
{
  if( asyncStatus == Windows::Foundation::AsyncStatus::Completed )
  {
    Windows::Foundation::Collections::IVectorView<Microsoft::Xbox::Tools::ConsoleExtensions::SimulationStatus>^ simStatus = action->GetResults();
    OutputDebugStringW(L"ERA Console API call succeeded: SimulationManager::GetStatusAsync\r\n");
    for (unsigned i = 0; i < simStatus->Size; i++)
    {
      Microsoft::Xbox::Tools::ConsoleExtensions::SimulationStatus status = simStatus->GetAt(i);
      OutputDebugStringW(status.Type.ToString()->Data());
      OutputDebugStringW(L"\r\n");
      OutputDebugStringW(status.Profile.ToString()->Data());
      OutputDebugStringW(L"\r\n");
    }
  }
  else
  {
    OutputDebugStringW(L"ERA Console API call failed: SimulationManager::GetStatusAsync\r\n");
  }
});  

Requirements

Namespace: Microsoft.Xbox.Tools.ConsoleExtensions

Metadata: microsoft.xbox.tools.consoleextensions.winmd

See also

Reference

SimulationManager Class

SimulationManager Members

Microsoft.Xbox.Tools.ConsoleExtensions Namespace