IPredictorServiceSiteAdmin2::RenameModel Method [C++]

Article
11/12/2009

Use this method to rename a model.

Definition

[C++]

HRESULT IPredictorServiceSiteAdmin2::RenameModel(BSTRsOldModelName,
  BSTRsNewModelName);

[Visual Basic]

Sub RenameModel(sOldModelName As String,
  sNewModelName As String)

Parameters

sOldModelName[C++]
[in] A BSTR that contains the old model name.
sOldModelName[Visual Basic]
A String that contains the old model name.
sNewModelName[C++]
[in] A BSTR that contains the new model name.
sNewModelName[Visual Basic]
A String that contains the new model name.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the following Error Values section for more details.

[Visual Basic] None.

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 method 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.

The following standard COM error value has a particular meaning in the context of this method.

E_FAIL

A model with the old name could not be found, or a model with the new name already exists.

Remarks

When renaming a model, update any sites that load the model using the LoadModelFromDB method of the PredictorClient object.

The name change is made to the model entry in the PredictorModels table in the Data Warehouse.

Use the slModels property of the PredictorServiceAdmin object to retrieve a list of available models. Use the RenameModelConfig method to rename a model configuration.

Passing an empty string for either model name will result in an invalid argument error.

Connect to the Data Warehouse using the Init method before calling the RenameModel method. For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.