Share via


Context.CurrentMiningModel Property

Gets the current mining model.

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

Syntax

'Declaration
Public Shared ReadOnly Property CurrentMiningModel As MiningModel
    Get
'Usage
Dim value As MiningModel

value = Context.CurrentMiningModel
public static MiningModel CurrentMiningModel { get; }
public:
static property MiningModel^ CurrentMiningModel {
    MiningModel^ get ();
}
static member CurrentMiningModel : MiningModel
static function get CurrentMiningModel () : MiningModel

Property Value

Type: Microsoft.AnalysisServices.AdomdServer.MiningModel
A MiningModel that represents the current mining model; nulla null reference (Nothing in Visual Basic) if not applicable.

Remarks

The return value will be nulla null reference (Nothing in Visual Basic) 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.

Examples

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;
}