Windows.Gaming.XboxLive.StorageApiContract
A collection of named game save blobs retrieved from a GameSaveContainer.
The status result of the asynchronous game save blob request.
Type: GameSaveErrorStatus
Collection of named game save blobs.
Type: **IMapView\<;String, IBuffer>;** \[JavaScript/C++\] | System.Collections.Generic.IReadOnlyDictionary\<;String, IBuffer>; \[.NET\]
Contains information about a game save blob. Call GameSaveBlobInfoQuery.GetBlobInfoAsync to obtain a **GameSaveBlobInfo** instance.
Name of the blob.
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Size, in bytes, of the blob.
Type: **Number** \[JavaScript\] | System.UInt32 \[.NET\] | **uint32** \[C++\]
Result of a GameSaveBlobInfoQuery.GetBlobInfoAsync operation.
Status result of the asynchronous game save blob info request.
Type: GameSaveErrorStatus
Information about a blob returned by GameSaveBlobInfoQuery.
Enumerates the blobs in a GameSaveContainer.
Asynchronously retrieves information for all blobs that match this query.
Type: **IAsyncOperation\<;GameSaveBlobInfoGetResult>;**
Asynchronously retrieves information for the specified subset of blobs that match this query.
Type: **Number** \[JavaScript\] | System.UInt32 \[.NET\] | **uint32** \[C++\]
Type: **Number** \[JavaScript\] | System.UInt32 \[.NET\] | **uint32** \[C++\]
Type: **IAsyncOperation\<;GameSaveBlobInfoGetResult>;**
Retrieves the number of blobs that match the query that created this GameSaveBlobInfoQuery object.
Type: **IAsyncOperation\<;UInt32>;**
Contains a collection of data blobs that represent a single saved game.
The name of this GameSaveContainer.
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
The provider that this container is stored in.
Type: GameSaveProvider
Creates a GameSaveBlobInfoQuery instance that retrieves the game save blobs within this container with names that begin with the specified prefix.
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Type: GameSaveBlobInfoQuery
Asynchronously retrieves blobs from the container.
Type: **IIterable\<;String>;** \[JavaScript/C++\] | System.Collections.Generic.IEnumerable\<;String>; \[.NET\]
Type: **IAsyncOperation\<;GameSaveBlobGetResult>;**
Reads blobs from this container, as specified by *blobsToRead*. The buffers passed in *blobsToRead* must be large enough to store the blob data.
Type: **IMapView\<;String, IBuffer>;** \[JavaScript/C++\] | System.Collections.Generic.IReadOnlyDictionary\<;String, IBuffer>; \[.NET\]
Type: **IAsyncOperation\<;GameSaveOperationResult>;**
Similar to SubmitUpdatesAsync, except that this method operates on a **PropertySet** instead of a mapped view (or dictionary in C\#).
Type: IPropertySet
Type: **IIterable\<;String>;** \[JavaScript/C++\] | System.Collections.Generic.IEnumerable\<;String>; \[.NET\]
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Type: **IAsyncOperation\<;GameSaveOperationResult>;**
Submits a set of changes to the game save blobs in this container. Changes can be writes to blobs or the deletion of existing blobs. If the container doesn't exist, then a new one is created. All writes and updates are applied atomically. Attempting to write and delete the same blob results in an error. Only 16MB of data may be written per call.
Type: **IMapView\<;String, IBuffer>;** \[JavaScript/C++\] | System.Collections.Generic.IReadOnlyDictionary\<;String, IBuffer>; \[.NET\]
Type: **IIterable\<;String>;** \[JavaScript/C++\] | System.Collections.Generic.IEnumerable\<;String>; \[.NET\]
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Type: **IAsyncOperation\<;GameSaveOperationResult>;**
Information about a game save container.
The name displayed to the user for this game save.
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Date and time that the game save container was last modified.
Type: **Date** \[JavaScript\] | System.DateTimeOffset \[.NET\] | Windows::Foundation::DateTime \[C++\]
The name of this game save container.
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Indicates whether the container needs to sync before updates can be submitted with SubmitUpdatesAsync or SubmitPropertySetUpdatesAsync.
Type: **Boolean** \[JavaScript\] | System.Boolean \[.NET\] | Platform::Boolean \[C++\]
The total size, in bytes, of the game save container and its blobs.
Type: **Number** \[JavaScript\] | System.UInt64 \[.NET\] | **uint64** \[C++\]
Result of a GameSaveContainerInfoQuery operation.
Status result of the asynchronous game save container info request.
Type: GameSaveErrorStatus
A collection of container information returned by GameSaveContainerInfoQuery.
Type: **IVectorView\<;GameSaveContainerInfo>;** \[JavaScript/C++\] | System.Collections.Generic.IReadOnlyList\<;GameSaveContainerInfo>; \[.NET\]
Enumerates game save containers within a game save provider.
Asynchronously retrieves information for all game save containers that match this query. Containers are enumerated in order of the most recently modified first.
Type: **IAsyncOperation\<;GameSaveContainerInfoGetResult>;**
Asynchronously retrieves information for the specified subset of game save containers that match this query. Containers are enumerated in order of the most recently modified first.
Type: **Number** \[JavaScript\] | System.UInt32 \[.NET\] | **uint32** \[C++\]
Type: **Number** \[JavaScript\] | System.UInt32 \[.NET\] | **uint32** \[C++\]
Type: **IAsyncOperation\<;GameSaveContainerInfoGetResult>;**
Retrieves the number of containers that match the query that created this GameSaveContainerInfoQuery object.
Type: **IAsyncOperation\<;UInt32>;**
Success and failure codes returned by game save operations.
| **Abort** | **abort** | 0x80004004 | The operation was aborted. |
| **BlobNotFound** | **blobNotFound** | 0x80830008 | The operation failed because a blob with the given name was not found in the container. |
| **ContainerNotInSync** | **containerNotInSync** | 0x8083000A | The operation failed because the container does not exist locally. This error can when submitting updates to a container that needs to sync, and a read, delete, or blob query has not been issued on the container. |
| **ContainerSyncFailed** | **containerSyncFailed** | 0x8083000B | The operation failed because the container could not be synced. This indicates that the user canceled a container sync due to not wanting to wait, or due to network failure and the user did not retry. This error can be returned by DeleteContainerAsync, ReadAsync, GetAsync, or a GameSaveBlobInfoQuery operation. |
| **InvalidContainerName** | **invalidContainerName** | 0x80830001 | The specified container name is empty, contains invalid characters, or is too long. |
| **NoAccess** | **noAccess** | 0x80830002 | The operation failed because the title does not have write access to the container storage space. |
| **NoXboxLiveInfo** | **noXboxLiveInfo** | 0x80830009 | The operation failed because the title does not have a proper title id or service configuration id. |
| **ObjectExpired** | **objectExpired** | 0x8083000D | The operation failed because the app has been suspended and the object is no longer valid. To perform game save operations after resuming, the app must request a new GameSaveProvider with GetForUserAsync or GetSyncOnDemandForUserAsync. |
| **Ok** | **ok** | 0 | The operation completed successfully. |
| **OutOfLocalStorage** | **outOfLocalStorage** | 0x80830003 | The operation failed because there was not enough local storage available. Although the user was given the chance to free up some local storage they chose not to do so. |
| **ProvidedBufferTooSmall** | **providedBufferTooSmall** | 0x80830007 | The operation failed because a buffer provided to read a blob was too small to receive the blob. |
| **QuotaExceeded** | **quotaExceeded** | 0x80830006 | The operation failed because the update would cause the storage space to exceed its quota. Use IGameSaveProvider.GetRemainingBytesInQuotaAsync to query the remaining quota space. |
| **UpdateTooBig** | **updateTooBig** | 0x80830005 | The operation failed because the update contained more than 16MB of data. |
| **UserCanceled** | **userCanceled** | 0x80830004 | The operation failed because the user canceled it. |
| **UserHasNoXboxLiveInfo** | **userHasNoXboxLiveInfo** | 0x8083000C | The operation failed because there is no Xbox Live information associated with the user account. This error can returned by GetForUserAsync or GetSyncOnDemandForUserAsync. |
Result of an asynchronous game save operation.
Status result of an asynchronous game save operation.
Type: GameSaveErrorStatus
**GameSaveProvider** is used to create, save, enumerate, and load Xbox Live game saves.
Called on a new GameSaveProvider instance, returns the names of containers that have changed since the application last ran.
Type: **IVectorView\<;String>;** \[JavaScript/C++\] | System.Collections.Generic.IReadOnlyList\<;String>; \[.NET\]
User associated with this game save provider and its game save containers.
Type: **User**
Creates a new GameSaveContainer to store a game save.
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Type: GameSaveContainer
Creates a GameSaveContainerInfoQuery instance that enumerates all containers in this game save provider.
Type: GameSaveContainerInfoQuery
Creates a GameSaveContainerInfoQuery instance that enumerates the containers in this game save provider that have names that begin with the specified prefix.
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Type: GameSaveContainerInfoQuery
Asynchronously deletes the specified game save container.
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Type: **IAsyncOperation\<;GameSaveOperationResult>;**
Gets a game save provider for the specified user.
Type: User
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Type: **IAsyncOperation\<;GameSaveProviderGetResult>;**
Get the bytes remaining in the user's quota for this game save provider.
Type: **IAsyncOperation\<;Int64>;**
Gets a partially-synced game save provider that syncs containers on demand.
Type: User
Type: **String** \[JavaScript\] | System.String \[.NET\] | Platform::String \[C++\]
Type: **IAsyncOperation\<;GameSaveProviderGetResult>;**
Result of a GetForUserAsync or GetSyncOnDemandForUserAsync. operation.
Status result of the asynchronous game save provider request.
Type: GameSaveErrorStatus
GameSaveProvider instance returned by a successful game save provider request.