XGameSaveDeleteContainerAsync

Article
06/22/2023

Deletes an XGameSaveContainer asynchronously.

Syntax

HRESULT XGameSaveDeleteContainerAsync(  
         XGameSaveProviderHandle provider,  
         const char* containerName,  
         XAsyncBlock* async  
)

Parameters

provider _In_
Type: XGameSaveProviderHandle

Handle to the XGameSaveProvider which contains the container to be deleted.

containerName _In_z_
Type: char*

The name of the container to be deleted.

async _In_
Type: XAsyncBlock*

AsyncBlock containing the context and function callback for the XGameSaveDeleteContainerAsync call.

Return value

Type: HRESULT

Function result.

Remarks

You will need to call XGameSaveDeleteContainerResult in the AsyncBlock's function callback to retrieve the results of the XGameSaveContainer deletion. This operation is serialized to ensure we always have a consistent representation of the data. There is a synchronous version of this function, XGameSaveDeleteContainer.

Requirements

Header: XGameSave.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles