TaxonomyClientService.GetTermsByLabel Method

Gets Term objects that match the search label.

Namespace:  Microsoft.SharePoint.Taxonomy.WebServices
Assembly:  Microsoft.SharePoint.Taxonomy (in Microsoft.SharePoint.Taxonomy.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Function GetTermsByLabel ( _
    label As String, _
    lcid As Integer, _
    matchOption As StringMatchOption, _
    resultCollectionSize As Integer, _
    termIds As String, _
    addIfNotFound As Boolean _
) As String
'Usage
Dim instance As TaxonomyClientService
Dim label As String
Dim lcid As Integer
Dim matchOption As StringMatchOption
Dim resultCollectionSize As Integer
Dim termIds As String
Dim addIfNotFound As Boolean
Dim returnValue As String

returnValue = instance.GetTermsByLabel(label, _
    lcid, matchOption, resultCollectionSize, _
    termIds, addIfNotFound)

[WebMethodAttribute]
public string GetTermsByLabel(
    string label,
    int lcid,
    StringMatchOption matchOption,
    int resultCollectionSize,
    string termIds,
    bool addIfNotFound
)

Parameters

• label
  Type: System.String

  Text upon which to match Terms.

• lcid
  Type: System.Int32

  LCID of language to make matches against.

• matchOption
  Type: Microsoft.SharePoint.Taxonomy.StringMatchOption

  StartsWith or ExactMatch to specify what type of matching is to be used.

• resultCollectionSize
  Type: System.Int32

  Maximum number of Term objects to be returned.

• termIds
  Type: System.String

• addIfNotFound
  Type: System.Boolean

  If matchOption is ExactMatch and no match is found and this flag is set to true, a new Term will be added to the TermStore object.

Return Value

Type: System.String
Terms which match the specified label.

Remarks

The serialization of the result as well as parameters is fully described in the protocol document MS-EMMWS.

See Also

Reference

TaxonomyClientService Class

TaxonomyClientService Members

Microsoft.SharePoint.Taxonomy.WebServices Namespace