XGameSaveDeleteContainer

Article
2025-04-28

Deletes an XGameSaveContainer from cloud storage.

Syntax

HRESULT XGameSaveDeleteContainer(  
         XGameSaveProviderHandle provider,  
         const char* containerName  
)

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.

Return value

Type: HRESULT

Function result.

Remarks

Note

This function isn't safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.

This operation may sometimes run slow, it is somewhat dependent on the size of the data being deleted. This operation is serialized to ensure we always have a consistent representation of the data. This method has an asynchronous version, XGameSaveDeleteContainerAsync.

void Sample::_DeleteContainer(const char* name) 
{ 
    HRESULT hr = XGameSaveDeleteContainer(_provider, name); 
    if (FAILED(hr)) 
    { 
        _HandleContainerErrors(name, hr); 
    } 
}

Requirements

Header: XGameSave.h

Library: xgameruntime.lib

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

Share via