ProfilePropertySettingsCollection.Remove(String) Method

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Removes a ProfilePropertySettings object from the collection.

public:
 void Remove(System::String ^ name);

public void Remove (string name);

member this.Remove : string -> unit

Public Sub Remove (name As String)

Parameters

name: String

The name of a ProfilePropertySettings object to remove from the collection.

Exceptions

ConfigurationException

There is no ProfilePropertySettings object with the specified key in the collection.

-or-

The element has already been removed.

-or-

The collection is read-only.

Examples

The following code example shows how to use the Remove method. This code example is part of a larger example provided for the ProfileSection class.

// Remove a PropertySettings from the group.
newPropGroup.PropertySettings.Remove("AvatarImage");
newPropGroup.PropertySettings.RemoveAt(0);

' Remove a PropertySettings from the group.
newPropGroup.PropertySettings.Remove("AvatarImage")
newPropGroup.PropertySettings.RemoveAt(0)

Remarks

This method inserts a remove element into the appropriate section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the appropriate section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection.

Applies to