Share via

XtfCacheTitleOS

  • Article

Adds a Game OS to the OS cache.

Syntax

HRESULT XtfCacheTitleOS(
         PCWSTR address,
         PCWSTR osIdentifier
)

Parameters

address
Type: PCWSTR

[in] The address of the console.

osIdentifier
Type: PCWSTR

[in] The identifier of the Game OS to be added. 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 added
  • 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 added

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 adding the specified Game OS to the cache on the console. You can use the XtfGetCachedTitleOSVersions function to get the version information of each Game OS cached on the console. You can also remove an existing Game OS from the cache by calling the XtfRemoveTitleOSFromCache or XtfRemoveTitleOSFromCacheByVersion functions. For more information about managing provisioned Game OS files, see Application Management (xbapp.exe) (NDA topic) and Provision (xbprovision.exe) (NDA topic).

Requirements

Header: xtfapi.h

Library: XtfApi.lib

Supported platforms: Windows (for Xbox console tools)

See also

Run from PC Deployment (NDA topic)
XTF Transport Errors (NDA topic)
Additional Xtf APIs