Represents a container for app settings. The methods and properties of this class support creating, deleting, enumerating, and traversing the container hierarchy.
Syntax
public ref class ApplicationDataContainer sealed : Object
Attributes
- DualApiPartitionAttribute()
- MarshalingBehaviorAttribute(Agile)
- VersionAttribute(NTDDI_WIN8)
Members
The ApplicationDataContainer class has these types of members:
Methods
The ApplicationDataContainer class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.
| Method | Description |
|---|---|
| CreateContainer | Creates or opens the specified settings container in the current settings container. |
| DeleteContainer | Deletes the specified settings container, its subcontainers, and all application settings in the hierarchy. |
Properties
The ApplicationDataContainer class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets the child application settings containers of this application settings container. | |
| Read-only | Gets the type (local or roaming) of the app data store that is associated with the current settings container. | |
| Read-only | Gets the name of the current settings container. | |
| Read-only | Gets an object that represents the settings in this settings container. |
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.
Windows Phone 8
This API is not implemented and will throw an exception if called.
Examples
Call the ApplicationDataContainer.CreateContainer | createContainer 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 ApplicationDataContainer.Values | values property to access the exampleSetting setting in the exampleContainer container.
Call the ApplicationDataContainer.DeleteContainer | deleteContainer method to delete the exampleContainer settings container when you have finished with it.
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");
Requirements
|
Minimum supported client | Windows 8 [Windows Store apps, desktop apps] |
|---|---|
|
Minimum supported server | Windows Server 2012 [Windows Store apps, desktop apps] |
|
Minimum supported phone | Windows Phone 8 |
|
Namespace |
|
|
Metadata |
|
|
DLL |
|
See also
- Tasks
- Quickstart: Local application data (JavaScript)
- Quickstart: Local application data (C#/VB/C++)
- Quickstart: Roaming application data (JavaScript)
- Quickstart: Roaming application data (C#/VB/C++)
- Concepts
- Application data overview
- Reference
- ApplicationData
- ApplicationDataCompositeValue
- ApplicationDataContainerSettings
- Samples
- Application data sample
Build date: 2/25/2013