CA_PropertyGetEx
HRESULT CA_PropertyGetEx (CAObjHandle objectHandle, ERRORINFO *errorInfo, const IID *interfaceId, int propertyID, unsigned int propertyType, void *propertyValue);
Purpose
 |
Note This function is used by the functions generated by the ActiveX Controller Instrument Driver Wizard. It is not intended to be used directly. |
Obtains the value of a Property.
Parameters
| Input | ||
| Name | Type | Description |
| objectHandle | CAObjHandle | An ActiveX object handle returned in an output parameter of an ActiveX server function or a function in the Creating ActiveX Objects class in this library. |
| interfaceId | const IID * | The interface id specifying the type of interface pointer to be used
for the property access. You must pass the UUID of an interface implemented by the object passed in the objectHandle parameter or zero to indicate the current interface id that is stored in that object handle. |
| propertyID | int | The Id of the Property. This Id can be obtained from the object's type library. |
| propertyType | unsigned int | The type of the property specified in the Property ID parameter. The type of the property can be any of the data types for variants and safe arrays except CAVT_NULL. |
| 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. |
| propertyValue | void * | The value of the property. The data type for this parameter depends on the data type of the property you specify for the propertyID parameter. Pass the address of a variable of the same data type that the propertyType parameter specifies. |
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