IPredModelBuilder::Stop
.gif "Ee798588.c++_off(en-US,CS.10).gif")
.gif "Ee798588.vb_on(en-US,CS.10).gif")
Use this method to stop execution of a specific model build thread.
Definition
HRESULT IPredModelBuilder::Stop(longlBuildID);
Parameters
lBuildID
[in] A long that identifies the model build thread.
Return Values
This method returns an HRESULT indicating whether it completed successfully. See the following Error Values section for more details.
Error Values
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.
The following standard COM error value has a particular meaning in the context of this method.
E_FAIL
The build ID was invalid or the status of the build thread was neither running nor paused.
Remarks
The build thread identifier is returned by the Start method when a model build is initiated.
The Stop method sets a flag that signals the data modeler for the specified build thread to stop when it is ready. The data modeler checks the flag each time it updates progress information. If the flag is set, the data modeler ends thread execution and performs necessary clean-up operations.
Use the Status property to access the current status of a build thread. If the data modeler has not completed the thread termination, the build thread status is PredBldShuttingDown.
After the thread terminates, the build identifier no longer indicates a valid build thread. A stopped thread may not be resumed. The thread must be restarted with the Start method.
Use the StopAllBuilds method to halt execution of all build threads associated with the PredModelBuilder object.