ApplicationData.RoamingSettings | roamingSettings property

Gets the application settings container in the roaming app data store.

Syntax

public ApplicationDataContainer RoamingSettings { get; }

Property value

Type: ApplicationDataContainer

The application settings container.

Remarks

The name of each setting can be 255 characters in length at most. Each setting can be up to 8K bytes in size and each composite setting can be up to 64K bytes in size. The sync engine may limit the total size of settings and files that can roam.

The Windows Runtime data types are supported for app settings.

Windows Phone 8

This API is not implemented and will throw an exception if called.

Examples

Use the RoamingSettings | roamingSettings property to get the settings in an ApplicationDataContainer object. Use the ApplicationDataContainer.Values | values property to access the settings in the roamingSettings container. This example creates and reads a setting named exampleSetting.

Call the ApplicationDataContainerSettings.Remove | remove method to delete the exampleSetting setting when you have finished with it.

var roamingSettings = Windows.Storage.ApplicationData.Current.RoamingSettings;

// Create a simple setting

roamingSettings.Values["exampleSetting"] = "Hello World";

// Read data from a simple setting

Object value = roamingSettings.Values["exampleSetting"];

if (!value)
{
    // No data
}
else
{
    // Access data in value
}

// Delete a simple setting

roamingSettings.Values.Remove("exampleSetting");

Requirements

See also

Tasks

Quickstart: Roaming application data (JavaScript)

Quickstart: Roaming application data (C#/VB/C++)

Concepts

Application data overview

Reference

ApplicationData

Build date: 2/25/2013