GameSaveProvider Class

Reference

Definition

Namespace:: Windows.Gaming.XboxLive.Storage

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

GameSaveProvider is used to create, save, enumerate, and load Xbox Live game saves.

public ref class GameSaveProvider sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Gaming.XboxLive.StorageApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class GameSaveProvider final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Gaming.XboxLive.StorageApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class GameSaveProvider

Public NotInheritable Class GameSaveProvider

Inheritance: Object Platform::Object IInspectable GameSaveProvider

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Xbox Live Extension SDK (introduced in 10.0.10240.0) Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Gaming.XboxLive.StorageApiContract (introduced in v1.0)

Remarks

Call GetForUserAsync or GetSyncOnDemandForUserAsync to obtain a GameSaveProvider instance.

Important

This API is targeted towards UWP games and apps with Xbox Live Enabled. Calls to these APIs made from sources that are not Xbox Live enabled will not be able to sync data to the cloud.

Properties

ContainersChangedSinceLastSync	Called on a new GameSaveProvider instance, returns the names of containers that have changed since the application last ran.
User	User associated with this game save provider and its game save containers.

Methods

CreateContainer(String)	Creates a new GameSaveContainer to store a game save.
CreateContainerInfoQuery()	Creates a GameSaveContainerInfoQuery instance that enumerates all containers in this game save provider.
CreateContainerInfoQuery(String)	Creates a GameSaveContainerInfoQuery instance that enumerates the containers in this game save provider that have names that begin with the specified prefix.
DeleteContainerAsync(String)	Asynchronously deletes the specified game save container.
GetForUserAsync(User, String)	Gets a game save provider for the specified user.
GetRemainingBytesInQuotaAsync()	Get the bytes remaining in the user's quota for this game save provider.
GetSyncOnDemandForUserAsync(User, String)	Gets a partially-synced game save provider that syncs containers on demand.

Applies to