IPredictorClient::SaveModelToFile Method [C++]

Article
11/12/2009

Use this method to save the currently loaded model to a file.

Definition

[C++]

HRESULT IPredictorClient::SaveModelToFile(BSTRsFilePath);

[Visual Basic]

Sub SaveModelToFile(sFilePath As String)

Parameters

sFilePath[C++]
[in] A BSTR that contains the file name, extension, and path relative to the working directory of the calling process.
sFilePath[Visual Basic]
[in] A String that contains the file name, extension, and path relative to the working directory of the calling process.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the 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.

Remarks

The directory where the file is saved must exist prior to the call.

A model must be loaded using the LoadModelFromDB or LoadModelFromFile methods before using the SaveModelToFile method.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

Example

oPredictorClient.SaveModelToFile "PredictionModel2.mdl"

Share via