SynonymCollection.AddSynonym Method (String, String, String, SynonymExpansionType)

Adds a synonym with the specified name, term, expansion type and description to 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 AddSynonym ( _
    synonym As String, _
    term As String, _
    description As String, _
    type As SynonymExpansionType _
) As Synonym
'Usage
Dim instance As SynonymCollection
Dim synonym As String
Dim term As String
Dim description As String
Dim type As SynonymExpansionType
Dim returnValue As Synonym

returnValue = instance.AddSynonym(synonym, _
    term, description, type)

Synonym AddSynonym(
    string synonym,
    string term,
    string description,
    SynonymExpansionType type
)

Parameters

• synonym
  Type: System.String

  The synonym name.

• term
  Type: System.String

  The synonym term.

• description
  Type: System.String

  The synonym description.

• type
  Type: Microsoft.SharePoint.Search.Extended.Administration.Keywords.SynonymExpansionType

  The expansion type of the synonym.

Return Value

Type: Microsoft.SharePoint.Search.Extended.Administration.Keywords.Synonym
A Synonym representing the added synonym.

Exceptions

Exception	Condition
ArgumentNullException	If the synonym name is [null].
AdminException	If the synonym name is already used by another synonym for the keyword.
AdminException	If the synonym name is already used by another keyword.

See Also

Reference

SynonymCollection Interface

SynonymCollection Members

AddSynonym Overload

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