CA_FillErrorInfoEx
HRESULT CA_FillErrorInfoEx (CAObjHandle objectHandle, const IID *interfaceId, HRESULT errorCode, ERRORINFO *errorInfo, int *errorInfoPresent);
Purpose
Queries the system for error information if the error code indicates failure.
If error information is available, CA_FillErrorInfoEx fills in the sCode, source, description, helpFile, and helpContext fields of the ERRORINFO structure.
CA_FillErrorInfoEx calls the system function GetErrorInfo to obtain the error information.
 |
Note This function is used by the functions generated by the ActiveX Controller Wizard. It is not intended to be used directly. |
Parameters
| Input | ||
| Name | Type | Description |
| objectHandle | CAObjHandle | The object handle representing the object that generated the error passed in the errorCode parameter. This handle is the object handle passed to the function that returned the error. |
| interfaceId | const IID * | The interface id specifying the interface that generated the error passed in the errorCode parameter. You must pass the UUID of an interface implemented by the object passed in the objectHandle parameter. |
| errorCode | HRESULT | An error code returned by an ActiveX server function or ActiveX Library function. |
| Output | ||
| Name | Type | Description |
| errorInfo | ERRORINFO | When the ActiveX server method invoked by this function fails with the error code DISP_E_EXCEPTION, descriptive information about the error code is stored in this parameter. The descriptive information includes the error code, source, and description. The information also can include a help file and help file context. When the ActiveX server method invoked by this function fails with the error codes DISP_E_PARAMNOTFOUND, DISP_E_TYPEMISMATCH, or E_INVALIDARG, the parameter position of the invalid argument can be stored in the errorParamPos member of this parameter. This parameter can be NULL. |
| errorInfoPresent | int | A boolean value indicating whether error information was available from the system. |
Return Value
| Name | Type | Description |
| status | HRESULT | A value indicating whether an error occurred. Negative error codes indicate function failure. Error codes are defined in CVIversion\include\cviauto.h and <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h. The LabWindows/CVI ActiveX Library explicitly returns error codes. Other error codes in winerror.h are generated by ActiveX servers and passed on to you by the LabWindows/CVI ActiveX Library. You can use CA_GetAutomationErrorString to get the description of an error code or CA_DisplayErrorInfo to display the description of the error code. |
Additional Information
Library: ActiveX Library
Include file: cviauto.h
LabWindows/CVI compatibility: LabWindows/CVI 6.0 and later