Context.CurrentMiningModel Property

Article
12/03/2008

Gets the current mining model.

Namespace: Microsoft.AnalysisServices.AdomdServer
Assembly: msmgdsrv (in msmgdsrv.dll)

Syntax

'Declaration
Public Shared ReadOnly Property CurrentMiningModel As MiningModel

public static MiningModel CurrentMiningModel { get; }

public:
static property MiningModel^ CurrentMiningModel {
    MiningModel^ get ();
}

/** @property */
public static MiningModel get_CurrentMiningModel ()

public static function get CurrentMiningModel () : MiningModel

Property Value

A MiningModel that represents the current mining model; null if not applicable.

Remarks

The return value will be null when called from a Multidimensional Expressions (MDX) query, or as a stored procedure. For more information on the differences between user-defined functions (UDFs) and stored orocedures, see User Defined Functions and Stored Procedures.

Example

In the following example, a UDF is created that returns the node description for a specified node. It uses the current context in which it is being run, retrieves the node from the current mining model (determined by the DMX FROM clause):

public string GetNodeDescription(string nodeUniqueName)
{
    return Context.CurrentMiningModel.GetNodeFromUniqueName(nodeUniqueName).Description;
}

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms