ISettingsList.RemoveAsync(String, Object) Method

Definition

Removes a specific element from the list, or does nothing if the element is not found.

public System.Threading.Tasks.Task RemoveAsync (string key, object state = default);

Parameters

key
String

The key.

state
Object

A caller-specified object that will be exposed on change events.

Returns

Returns Task.

Exceptions

May be thrown when key is null.

May be thrown when key is empty.

Thrown when the value cannot be persisted to the private store (for example, because the disk is full).

Remarks

This method is safe to access from any thread.

Applies to