-api-id | -api-type |
---|---|
T:Windows.Storage.ApplicationDataContainer |
winrt class |
Represents a container for app settings. The methods and properties of this class support creating, deleting, enumerating, and traversing the container hierarchy.
Note
There is no settings container for the temporary app data store.
The Values property gets an ApplicationDataContainerSettings object that provides access to the settings stored in the container.
Call the ApplicationDataContainer.CreateContainer method to create a settings container, or to return an existing container. This example creates a settings container named exampleContainer
and adds a setting named exampleSetting
. The Always value from the ApplicationDataCreateDisposition enumeration indicates that the container should be created if it does not already exist.
Use the ApplicationDataContainer.Values property to access the exampleSetting
setting in the exampleContainer
container.
Call the ApplicationDataContainer.DeleteContainer method to delete the exampleContainer
settings container when you have finished with it.
Windows.Storage.ApplicationDataContainer localSettings = Windows.Storage.ApplicationData.Current.LocalSettings;
// Create a setting in a container
Windows.Storage.ApplicationDataContainer container =
localSettings.CreateContainer("exampleContainer", Windows.Storage.ApplicationDataCreateDisposition.Always);
if (localSettings.Containers.ContainsKey("exampleContainer"))
{
localSettings.Containers["exampleContainer"].Values["exampleSetting"] = "Hello, Windows!";
}
// Read data from a setting in a container
bool hasContainer = localSettings.Containers.ContainsKey("exampleContainer");
bool hasSetting = false;
if (hasContainer)
{
hasSetting = localSettings.Containers["exampleContainer"].Values.ContainsKey("exampleSetting");
}
// Delete a container
localSettings.DeleteContainer("exampleContainer");
Windows::Storage::ApplicationDataContainer localSettings{
Windows::Storage::ApplicationData::Current().LocalSettings() };
// Create a setting in a container.
Windows::Storage::ApplicationDataContainer container{
localSettings.CreateContainer(L"exampleContainer", Windows::Storage::ApplicationDataCreateDisposition::Always) };
if (localSettings.Containers().HasKey(L"exampleContainer"))
{
auto values{ localSettings.Containers().Lookup(L"exampleContainer").Values() };
values.Insert(L"exampleSetting", winrt::box_value(L"Hello, Windows!"));
}
// Read data from a setting in a container.
bool hasContainer{ localSettings.Containers().HasKey(L"exampleContainer") };
bool hasSetting{ false };
if (hasContainer)
{
auto values{ localSettings.Containers().Lookup(L"exampleContainer").Values() };
hasSetting = values.HasKey(L"exampleSetting");
}
// Delete a container.
localSettings.DeleteContainer(L"exampleContainer");
ApplicationDataContainer^ localSettings = ApplicationData::Current->LocalSettings;
// Create a setting in a container
ApplicationDataContainer^ container =
localSettings->CreateContainer("exampleContainer", ApplicationDataCreateDisposition::Always);
if (localSettings->Containers->HasKey("exampleContainer"))
{
auto values = localSettings->Containers->Lookup("exampleContainer")->Values;
values->Insert("exampleSetting", "Hello, Windows!");
}
// Read data from a setting in a container
bool hasContainer = localSettings->Containers->HasKey("exampleContainer");
bool hasSetting = false;
if (hasContainer)
{
auto values = localSettings->Containers->Lookup("exampleContainer")->Values;
hasSetting = values->HasKey("exampleSetting");
}
// Delete a container
localSettings->DeleteContainer("exampleContainer");
Dim localSettings As Windows.Storage.ApplicationDataContainer = Windows.Storage.ApplicationData.Current.LocalSettings
' Create a setting in a container
Dim container As Windows.Storage.ApplicationDataContainer =
localSettings.CreateContainer("exampleContainer", Windows.Storage.ApplicationDataCreateDisposition.Always)
If localSettings.Containers.ContainsKey("exampleContainer") Then
localSettings.Containers("exampleContainer").Values("exampleSetting") = "Hello, Windows!"
End If
' Read data from a setting in a container
Dim hasContainer As Boolean = localSettings.Containers.ContainsKey("exampleContainer")
Dim hasSetting As Boolean = False
If hasContainer Then
hasSetting = localSettings.Containers("exampleContainer").Values.ContainsKey("exampleSetting")
End If
' Delete a container
localSettings.DeleteContainer("exampleContainer")
Store and retrieve settings and other app data, ApplicationData, ApplicationDataCompositeValue, ApplicationDataContainerSettings, Application data sample