SynonymCollection.GetEnumerator Method (SynonymSortField, SortDirection, Int32, Int32)

Gets an enumerator for a subset of the the synonyms in the collection, sorting on the specified filed ion the specified direction.

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

Syntax

'Declaration
Function GetEnumerator ( _
    sortField As SynonymSortField, _
    sortDirection As SortDirection, _
    offset As Integer, _
    count As Integer _
) As IEnumerator(Of Synonym)
'Usage
Dim instance As SynonymCollection
Dim sortField As SynonymSortField
Dim sortDirection As SortDirection
Dim offset As Integer
Dim count As Integer
Dim returnValue As IEnumerator(Of Synonym)

returnValue = instance.GetEnumerator(sortField, _
    sortDirection, offset, count)

IEnumerator<Synonym> GetEnumerator(
    SynonymSortField sortField,
    SortDirection sortDirection,
    int offset,
    int count
)

Parameters

• sortField
  Type: Microsoft.SharePoint.Search.Extended.Administration.Keywords.SynonymSortField

  The field on which the collection is to be sorted.

• sortDirection
  Type: Microsoft.SharePoint.Search.Extended.Administration.Common.SortDirection

  The sort direction.

• offset
  Type: System.Int32

  The offset in the result set from which values are returned.

• count
  Type: System.Int32

  The number of elements to return.

Return Value

Type: System.Collections.Generic.IEnumerator<Synonym>
An [IEnumerator] over the Synonyms.

Remarks

The count and offset values are applied to the result after sorting on the specified field in the specified direction. This can be used for paging.

See Also

Reference

SynonymCollection Interface

SynonymCollection Members

GetEnumerator Overload

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

SynonymSortField

SortDirection