SearchDocument.Remove(String) Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0

Source:

SearchDocument.Dictionary.cs

Removes the element with the specified key from the IDictionary<TKey,TValue>.

public bool Remove (string key);

abstract member Remove : string -> bool
override this.Remove : string -> bool

Public Function Remove (key As String) As Boolean

Parameters

key

String

The key of the element to remove.

Returns

Boolean

true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary<TKey,TValue>.

Implements

Remove(TKey)

Exceptions

ArgumentNullException

key is null.

NotSupportedException

The IDictionary<TKey,TValue> is read-only.