GameSaveProvider.CreateContainer(String) Method
Definition
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.
Creates a new GameSaveContainer to store a game save.
public:
virtual GameSaveContainer ^ CreateContainer(Platform::String ^ name) = CreateContainer;
GameSaveContainer CreateContainer(winrt::hstring const& name);
public GameSaveContainer CreateContainer(string name);
function createContainer(name)
Public Function CreateContainer (name As String) As GameSaveContainer
Parameters
- name
-
String
Platform::String
winrt::hstring
Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]
Name of the new game save container. The maximum length for the container name is 256 characters.
Returns
Type: GameSaveContainer
A new, empty, named GameSaveContainer instance.
Remarks
Valid characters for the path portion of the container name (up to and including the final forward slash) include uppercase letters (A-Z), lowercase letters (a-z), numbers (0-9), underscore (_), and forward slash (/). The path portion may be empty.
Valid characters for the filename portion (everything after the final forward slash) include uppercase letters (A-Z), lowercase letters (a-z), numbers (0-9), underscore (_), period (.), and hyphen (-). The filename may not be empty, end in a period, or contain two consecutive periods.
If name is invalid, the operation fails with GameSaveErrorStatus.InvalidContainerName.
The string specified in name is used to programmatically refer to the game save, and is not the display name shown to the user.
The returned GameSaveContainer is empty and contains no game save blobs.
Use GameSaveContainer.SubmitUpdatesAsync to write game save blobs to the container.