This topic has not yet been rated - Rate this topic

IsolatedStorageSettings.Remove Method

Silverlight

Removes the entry with the specified key.

Namespace: System.IO.IsolatedStorage
Assembly: System.Windows (in System.Windows.dll)

Copy

public bool Remove(
	string key
)

Parameters

key: Type: System.String
The key for the entry to be deleted.

Return Value

Type: System.Boolean
true if the specified key was removed; otherwise, false.

Implements

IDictionary<TKey, TValue>.Remove(TKey)

Exceptions

Exception	Condition
ArgumentNullException	key is null.

Remarks

Use this method to remove key-value pairs from isolated storage. If the key does not exist, the method returns false; no entry is deleted and no exception is thrown.

Examples

The following example tries to remove a key-value pair for the user's name from the settings dictionary. A message is displayed in a TextBox named tbResults that indicates whether the name was removed or not found. This example is part of a larger example for the IsolatedStorageSettings class.

Copy


if (userSettings.Remove("name") == true)
{
    tbResults.Text = "Name removed. Refresh page to see changes.";
}
else
{
    tbResults.Text = "Name could not be removed. Key does not exist.";
}

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Reference

IsolatedStorageSettings Class

System.IO.IsolatedStorage Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ