UsageAnalyticsJobDefinition.StartAnalysis method (String)

  • Article

Starts the analysis if it is not running already.

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

Syntax

'Declaration
Public Function StartAnalysis ( _
    directory As String _
) As String
'Usage
Dim instance As UsageAnalyticsJobDefinition
Dim directory As String
Dim returnValue As String

returnValue = instance.StartAnalysis(directory)

public string StartAnalysis(
    string directory
)

Parameters

Return value

Type: System.String

Exceptions

Exception Condition
InvalidOperationException

The exception that is thrown when the timer job has not been disabled or if it is currently running.
ServiceNotFoundException

The exception that is thrown when an instance of IAnalysisEngineAgent cannot be resolved.
ArgumentException

The exception that is thrown when directory is in the wrong format.
ArgumentNullException

The exception that is thrown when directory is null or empty.
DirectoryNotFoundException

The exception that is thrown when directory cannot be resolved.

See also

Reference

UsageAnalyticsJobDefinition class

UsageAnalyticsJobDefinition members

StartAnalysis overload

Microsoft.Office.Server.Search.Analytics namespace