RankingParameter Class

Represents a ranking parameter used for rank computation in Enterprise Search in Microsoft Office SharePoint Server 2007.

Inheritance Hierarchy

System.Object
  Microsoft.Office.Server.Search.Administration.RankingParameter

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

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public NotInheritable Class RankingParameter

'Usage
Dim instance As RankingParameter

[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public sealed class RankingParameter

Remarks

Use the RankingParameters() property of the Ranking class to get the collection of ranking parameters for a Shared Services Provider (SSP).

Use an indexer to return a single ranking parameter from the RankParamCollection object. For example, assuming the collection is assigned to a variable named rankingParams, use rankingParams[index] in Microsoft Visual C# or rankingParams(index) in Microsoft Visual Basic, where index is the index number of the ranking parameter in the collection, or a string containing the name of the ranking parameter.

Examples

The following code example writes out the ranking parameter names and built-in values to the console window.

Prerequisites

Ensure a Shared Services Provider is already created.

Project References

Add the following Project References in your console application code project before running this sample:

• Microsoft.SharePoint

• Microsoft.Office.Server

• Microsoft.Office.Server.Search

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Office.Server.Search.Administration;
using Microsoft.SharePoint;
namespace RankingParameterSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
     //Replace <SiteName> with the name of a site using the Shared Services Provider.
                string strURL = "http://<SiteName>";
                Ranking searchRanking = new Ranking(SearchContext.GetContext(new SPSite(strURL)));
                RankParamCollection rankParams = searchRanking.RankingParameters;

                foreach (RankingParameter rankParam in rankParams)
                {
                    Console.WriteLine("NAME: " + rankParam.Name + "...VALUE: " + rankParam.Value);
                }
            }

            catch (Exception ex)
            {
                Console.WriteLine(ex.ToString());
            }
        }
    }
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

RankingParameter Members

Microsoft.Office.Server.Search.Administration Namespace

Other Resources

Improving Relevance

Enterprise Search Relevance Architecture Overview