IPredModelBuilder::get_Status Property [C++]
The Status property is a read-only ePredBuildStatus enumerated type. This property indicates the current status of a model build thread.
Definition
[C++]
HRESULT IPredModelBuilder::get_Status(longlBuildID,
ePredBuildStatus*peStatus);
[Visual Basic]
Property Status(lBuildID As Long) As Enum
Parameters
- lBuildID[C++]
[in] A long that contains the build identifier used to select a specific build thread. - lBuildID[Visual Basic]
[in] A Long that contains the build identifier used to select a specific build thread. - peStatus[C++]
[out, retval] A pointer to an ePredBuildStatus enumerated type that indicates the status of the specified thread.
[C++]
Return Values
This method returns an HRESULT indicating whether it completed successfully. See the following Error Values section for more details. The IErrorInfo interface provides more specific error information.
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 following table defines the possible values for the ePredBuildStatus enumerated build states.
| Name | Value | Description |
|---|---|---|
| PredBldRunning | 0 | Is currently running. |
| PredBldPaused | 1 | Is paused. |
| PredBldShuttingDown | 2 | Is shutting down in response to the Stop method. |
BuildIDs become invalid when a build is finished, either successfully or due to failure. For status information on finished builds, or to monitor the build process, view the event log.
Initiate the build thread using the Start method before you access the thread using the Status property.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
[C++]
The peStatus parameter contains valid data only if the property is accessed successfully.
See Also
[Visual Basic]PredModelBuilder Object
[Visual Basic]PredModelBuilder.Start
[Visual Basic]PredModelBuilder.Stop
Copyright © 2005 Microsoft Corporation.
All rights reserved.