SynonymCollection.RemoveSynonym Method

Removes the synonym with the specified term from the collection.

Namespace:  Microsoft.SharePoint.Search.Extended.Administration.Keywords
Assembly:  Microsoft.SharePoint.Search.Extended.Administration (in Microsoft.SharePoint.Search.Extended.Administration.dll)

Syntax

'Declaration
Function RemoveSynonym ( _
    synonym As String _
) As Boolean
'Usage
Dim instance As SynonymCollection
Dim synonym As String
Dim returnValue As Boolean

returnValue = instance.RemoveSynonym(synonym)

bool RemoveSynonym(
    string synonym
)

Parameters

• synonym
  Type: System.String

  The synonym term.

Return Value

Type: System.Boolean
[true] if the synonym with the specified term could be removed.

Exceptions

Exception	Condition
ArgumentNullException	If the synonym name is [null].
AdminException	If the synonym with the specified name does not exist for the keyword.

See Also

Reference

SynonymCollection Interface

SynonymCollection Members

Microsoft.SharePoint.Search.Extended.Administration.Keywords Namespace