IPredModelBuilder::get_slRunningModels Property [C++]
The slRunningModels property is a read-only SimpleList object that contains information on the active (running and paused) model build threads.
Definition
[C++]
HRESULT IPredModelBuilder::get_slRunningModels(ISimpleList**ppslVal);
[Visual Basic]
Property slRunningModels() As Object
Parameters
- ppslVal[C++]
[out, retval] The address of a pointer to the ISimpleList interface for the SimpleList object used to return the infomation on the active model build threads.
[Visual Basic] None.
[C++]
Return Values
This method returns an HRESULT indicating whether it completed successfully. See the following Error Values section for more details.
Error Values
[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.
[Visual Basic] This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
Remarks
The SimpleList object, slRunningModels, contains a Dictionary object for each running model. The keys of the Dictionary object are the names of the model properties as listed in the PredictorModels Table except for the properties dependent on a successful finished build. The properties that are unavailable are: DateCreated, DataFitScore, RecommendScore, and BuildTime. After a successful build, these properties are available through the slModels property of the PredictorServiceAdmin object or the dModelInfo property of the PredictorServiceSiteAdmin object. The following table describes a few of the keys contained in the Dictionary object. For information about the remaining keys, see PredictorModels Table.
| Key Name | Type | Description |
|---|---|---|
| DWResourceName | [C++] BSTR
[Visual Basic] String |
Name of the Data Warehouse resource where the model configuration is defined. |
| ModelCfgName | [C++] BSTR
[Visual Basic] String |
Name of the model configuration used to build the model. |
| BuildID | [C++] long
[Visual Basic] Long |
The ID of the build thread. |
| ModelName | [C++] BSTR
[Visual Basic] String |
Model name. |
Use the Status property to check the status of a specific model build thread.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
[C++]
The ppslVal parameter contains valid data only if the property is accessed successfully.
See Also
[C++]IPredictorServiceAdmin::get_slModels
[C++]IPredictorServiceSiteAdmin::get_dModelInfo
[C++]IPredModelBuilder::StopAllBuilds
[C++]IPredModelBuilder::get_Status
[Visual Basic]PredictorServiceAdmin.slModels
[Visual Basic]PredictorServiceSiteAdmin.dModelInfo
[Visual Basic]PredModelBuilder Object
[Visual Basic]PredModelBuilder.Start
[Visual Basic]PredModelBuilder.Stop
[Visual Basic]PredModelBuilder.StopAllBuilds
[Visual Basic]PredModelBuilder.Status
Copyright © 2005 Microsoft Corporation.
All rights reserved.