SearchServiceApplicationProxy.GetLocationDescription method

Article
05/27/2015

Retrieves the federated location description.

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

Syntax

'Declaration
Public Function GetLocationDescription ( _
    id As Integer _
) As String
'Usage
Dim instance As SearchServiceApplicationProxy
Dim id As Integer
Dim returnValue As String

returnValue = instance.GetLocationDescription(id)

public string GetLocationDescription(
    int id
)

Parameters

id
Type: System.Int32

The ID of the federated location whose description will be retrieved.

Return value

Type: System.String
The description of the federated location definition.

Implements

ISearchSiteAdministrationServiceApplication.GetLocationDescription(Int32)

Exceptions

Exception	Condition
Exception	An error, such as a SearchServiceApplicationFault, occurred during application execution.

Remarks

The value of the id parameter must not be null .