ApplicationDataContainer ApplicationDataContainer ApplicationDataContainer ApplicationDataContainer Class

Represents a container for app settings. The methods and properties of this class support creating, deleting, enumerating, and traversing the container hierarchy.

Syntax

Declaration

public sealed class ApplicationDataContainerpublic sealed class ApplicationDataContainerPublic NotInheritable Class ApplicationDataContainer

Remarks

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.

Examples

Call the CreateContainer(System.String,Windows.Storage.ApplicationDataCreateDisposition) method to create a settings container. This example creates a settings container named exampleContainer and adds a setting named exampleSetting. The Always | always value from the ApplicationDataCreateDisposition enumeration indicates that the container should be created if it does not already exist.

Use the Values property to access the exampleSetting setting in the exampleContainer container.

Call the DeleteContainer(System.String) method to delete the exampleContainer settings container when you have finished with it.

var applicationData = Windows.Storage.ApplicationData.current;

var localSettings = applicationData.localSettings;

// Create a setting in a container

var container = localSettings.createContainer("exampleContainer", 
    Windows.Storage.ApplicationDataCreateDisposition.Always);

if (localSettings.containers.hasKey("exampleContainer"))
{
    localSettings.containers.lookup("exampleContainer").values["exampleSetting"] = "Hello Windows";
}

// Read data from a setting in a container

var hasContainer = localSettings.containers.hasKey("exampleContainer");

if (hasContainer)
{
    // Access data in: 
    //   localSettings.containers.lookup("exampleContainer").values.hasKey("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("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");
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")
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");

Properties summary

Gets the child application settings containers of this application settings container.

Gets the type (local or roaming) of the app data store that is associated with the current settings container.

Gets the name of the current settings container.

Gets an object that represents the settings in this settings container.

Methods summary

Creates or opens the specified settings container in the current settings container.

Deletes the specified settings container, its subcontainers, and all application settings in the hierarchy.

Properties

  • Containers
    Containers
    Containers
    Containers

    Gets the child application settings containers of this application settings container.

    public IMapView<ApplicationDataContainer> Containers { get; }public IMapView<ApplicationDataContainer> Containers { get; }Public ReadOnly Property Containers As IMapView<ApplicationDataContainer>

    Property Value

    • The application settings containers.

  • Locality
    Locality
    Locality
    Locality

    Gets the type (local or roaming) of the app data store that is associated with the current settings container.

    public ApplicationDataLocality Locality { get; }public ApplicationDataLocality Locality { get; }Public ReadOnly Property Locality As ApplicationDataLocality

    Property Value

    Remarks

    There is no temporary settings container, so the ApplicationDataLocality value can't be returned by this property.

  • Name
    Name
    Name
    Name

    Gets the name of the current settings container.

    public string Name { get; }public string Name { get; }Public ReadOnly Property Name As string

    Property Value

    • string
      string
      string
      string

      The name of the settings container.

  • Values
    Values
    Values
    Values

    Gets an object that represents the settings in this settings container.

    public IPropertySet Values { get; }public IPropertySet Values { get; }Public ReadOnly Property Values As IPropertySet

    Property Value

    Remarks

    For an example of using an ApplicationData property to get its associated Values, see LocalSettings.

Methods

  • CreateContainer(System.String,Windows.Storage.ApplicationDataCreateDisposition)
    CreateContainer(System.String,Windows.Storage.ApplicationDataCreateDisposition)
    CreateContainer(System.String,Windows.Storage.ApplicationDataCreateDisposition)
    CreateContainer(System.String,Windows.Storage.ApplicationDataCreateDisposition)

    Creates or opens the specified settings container in the current settings container.

    public ApplicationDataContainer CreateContainer(System.String,Windows.Storage.ApplicationDataCreateDisposition)public ApplicationDataContainer CreateContainer(System.String,Windows.Storage.ApplicationDataCreateDisposition)Public Function CreateContainer(System.String,Windows.Storage.ApplicationDataCreateDisposition) As ApplicationDataContainer

    Parameters

    Returns

  • DeleteContainer(System.String)
    DeleteContainer(System.String)
    DeleteContainer(System.String)
    DeleteContainer(System.String)

    Deletes the specified settings container, its subcontainers, and all application settings in the hierarchy.

    public void DeleteContainer(System.String)public void DeleteContainer(System.String)Public Function DeleteContainer(System.String) As void

    Parameters

    • name
      System.String
      System.String
      System.String
      System.String

      The name of the settings container.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute

Details

Assembly

Windows.Storage.dll