SearchServiceApplicationProxy.GetSpecialTermsInfo method

Retrieves a list of keywords from the site collection for a specified keyword consumer group.

Namespace:  Microsoft.Office.Server.Search.Administration
Assembly:  Microsoft.Office.Server.Search (in Microsoft.Office.Server.Search.dll)

Syntax

'Declaration
Public Function GetSpecialTermsInfo ( _
    view As KeywordView, _
    filter As KeywordFilter, _
    value As String, _
    consumerGpId As String _
) As Dictionary(Of String, Keyword)
'Usage
Dim instance As SearchServiceApplicationProxy
Dim view As KeywordView
Dim filter As KeywordFilter
Dim value As String
Dim consumerGpId As String
Dim returnValue As Dictionary(Of String, Keyword)

returnValue = instance.GetSpecialTermsInfo(view, _
    filter, value, consumerGpId)

public Dictionary<string, Keyword> GetSpecialTermsInfo(
    KeywordView view,
    KeywordFilter filter,
    string value,
    string consumerGpId
)

Parameters

• view
  Type: Microsoft.Office.Server.Search.Administration.KeywordView

  One of the enumeration values that specify the type of keywords to include in the result set.

• filter
  Type: Microsoft.Office.Server.Search.Administration.KeywordFilter

  One of the enumeration values that specifies which keyword attributes are used for comparison.

• value
  Type: System.String

  The value for comparison when performing the filtering.

• consumerGpId
  Type: System.String

  The ID of the keyword consumer group.

Return value

Type: System.Collections.Generic.Dictionary<String, Keyword>
The list of term/keyword pairs.

Implements

ISearchSiteAdministrationServiceApplication.GetSpecialTermsInfo(KeywordView, KeywordFilter, String, String)

Exceptions

Remarks

The list of keywords can be filtered according to criteria specified in the view and filter parameters.

See also

Reference

SearchServiceApplicationProxy class

SearchServiceApplicationProxy members

Microsoft.Office.Server.Search.Administration namespace