XtfStartTitleOSByVersion

Article
06/22/2023

Starts or restarts the Game OS matching the specified FourPartVersion from the cache on the console.

Syntax

HRESULT XtfStartTitleOSByVersion(
         PCWSTR address,
         FourPartVersion version
)

Parameters

address
Type: PCWSTR

[in] The address of the console.

version
Type: FourPartVersion

[in] The four-part version information of the Game OS to start.

Return value

Type: HRESULT

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

Remarks

Use this function to start or restart the Game OS matching the specified FourPartVersion from the cache on the console. You can use the XtfGetCachedTitleOSVersions function to get the FourPartVersion of each Game OS cached on the console, or the XtfGetTitleOSFourPartVersion function to get the FourPartVersion of the Game OS for the currently running title.

If you don't have a FourPartVersion for the Game OS you want to start or restart, use the XtfStartTitleOS function instead to start or restart a Game OS by specifying a different identifier, such as the full path and file name of the GameOs.vxd file for a Game OS. You can also use the XtfStartTitleOSByGameConfig function to start or restart the Game OS identified in the specified contents of a MicrosoftGame.config file.

If needed, you can add a Game OS to the cache on the console by calling the XtfCacheTitleOS function. For more information about managing provisioned Game OS files, see Application Management (xbapp.exe) (NDA topic)Authorization required and Provision (xbprovision.exe) (NDA topic)Authorization required.

Requirements

Header: xtfapi.h

Library: XtfApi.lib

Supported platforms: Windows (for Xbox console tools)

Share via