Skip to main content

WdLaunchRemoteGame

Launches a game on a remote device.

Syntax

Parameters

_In_z_ remoteDevice
Type: const char*
The hostname or IP address of the remote device (e.g., "192.168.1.100" or "MyDevKit"). _In_z_ remotePath
Type: const char*
The path to the game executable on the remote device. Can be an absolute path (e.g., "D:\\Games\\MyGame\\game.exe") or a relative path that resolves against the common root (e.g., "MyGame\\game.exe"). _In_opt_z_ args
Type: const char*
Optional. Command-line arguments to pass to the game executable (e.g., "-windowed -debug"). Pass nullptr if no arguments are needed. _In_opt_ launchOptions
Type: WdLaunchOptions*
Optional. Specifies launch mode and common root alias. Pass nullptr to use default settings (Immediate launch, default common root). _Out_opt_ processId
Type: uint32_t*
Optional. Receives the process ID of the launched game. Pass nullptr if the process ID is not needed. _Out_opt_ threadId
Type: uint32_t*
Optional. Receives the thread ID of the launched game’s main thread. Pass nullptr if the thread ID is not needed.

Return value

Type: HRESULT Returns S_OK if successful; otherwise, returns an error code.

Error codes

Remarks

Only one game process may be running on the remote device at a time. If a game is already running, this function will automatically terminate it and launch it again. The existing game can be terminated using WdTerminateRemoteGame before launching a new one. When launched with WdLaunchMode::Suspended, the game process starts in a suspended state. Use WdResumeRemoteGame to resume execution. This is useful for attaching a debugger before the game begins executing.

Examples

Example 1: Launch a game on a remote device

Launches a previously copied game executable using default settings (immediate execution, default common root).

Example 2: Launch in suspended mode for debugging

Launches the game in a suspended state so a debugger can be attached before execution begins. After the debugger is connected, the user presses Enter to resume the process.

Example 3: Copy and launch workflow

Demonstrates the typical iteration cycle: copy game files to the remote device, then launch the executable. This is the most common end-to-end workflow for the XBOX PC Remote Iteration API.

Requirements

See also

Last modified on August 20, 2026