XtfRemoveTitleOSFromCache

Article
06/22/2023

Removes a Game OS from the cache on the console.

Syntax

HRESULT XtfRemoveTitleOSFromCache(
         PCWSTR address,
         PCWSTR osIdentifier
)

Parameters

address
Type: PCWSTR

[in] The address of the console.

osIdentifier
Type: PCWSTR

[in] The identifier of the OS to be removed. This identifier can be one of the following:

The full path and file name of a MicrosoftGame.config file that contains the four-part version number of the Game OS version to be removed
The full path and file name of a GameOs.xvd file
The full path to a directory that contains a MicrosoftGame.config or GameOS.vxd file
The four-part version number of the Game OS to be removed

Examples of valid identifiers:

D:\MyGame
\MyDevPC\share\MyGame\MicrosoftGame.config
xd:\Titles\MyGamePFN\GameOs.xvd
10.0.18236.1002

Return value

Type: HRESULT

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

Remarks

Use this function to manage provisioned Game OS files by removing the specified Game OS from the cache on the console. If you attempt to remove a Game OS flagged as a fallback OS, an error occurs.

If you have a FourPartVersion for the Game OS you want to remove, use the XtfRemoveTitleOSFromCacheByVersion function instead to remove that Game OS version. 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.

You can also 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