IPredModelBuilder::StopAllBuilds
.gif "Ee811690.c++_off(en-US,CS.10).gif")
.gif "Ee811690.vb_on(en-US,CS.10).gif")
Use this method to stop execution of all model build threads associated with the PredModelBuilder object.
Definition
HRESULT IPredModelBuilder::StopAllBuilds();
Parameters
None.
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.
Remarks
The StopAllBuilds method sets a flag that signals each build thread to stop when it is ready. If the flag is set for a build thread, the data modeler for that thread ends thread execution and performs necessary clean-up operations.
Use the Status property to access the current status of a build thread. If a data modeler has not completed thread termination, the thread status for the modeler 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 Stop method to stop a specific build thread.