SynonymCollection.AddSynonym Method (String, String, String, Nullable<DateTime>, Nullable<DateTime>, Context, SynonymExpansionType)

Adds a synonym with the specified name, term, description, date range, context and expansion type 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, _
    start As Nullable(Of DateTime), _
    end As Nullable(Of DateTime), _
    context As Context, _
    type As SynonymExpansionType _
) As Synonym
'Usage
Dim instance As SynonymCollection
Dim synonym As String
Dim term As String
Dim description As String
Dim start As Nullable(Of DateTime)
Dim end As Nullable(Of DateTime)
Dim context As Context
Dim type As SynonymExpansionType
Dim returnValue As Synonym

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

Synonym AddSynonym(
    string synonym,
    string term,
    string description,
    Nullable<DateTime> start,
    Nullable<DateTime> end,
    Context context,
    SynonymExpansionType type
)

Parameters

• synonym
  Type: System.String

  The synonym name.

• term
  Type: System.String

  The synonym term.

• description
  Type: System.String

  The synonym description.

• start
  Type: System.Nullable<DateTime>

  The date from which the synonym is valid.

• end
  Type: System.Nullable<DateTime>

  The date to which the synonym is valid.

• context
  Type: Microsoft.SharePoint.Search.Extended.Administration.Keywords.Context

  The context to which this synonym is to be attached.

• 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