CA_GetLocale
HRESULT CA_GetLocale (CAObjHandle objectHandle, LCID *locale);
Purpose
Obtains the locale that the ActiveX server uses to interpret the arguments that it receives as parameters to its functions.
Parameters
| Input | ||
| Name | Type | Description |
| objectHandle | CAObjHandle | ActiveX object handle returned by one of the object creation functions in this library or an ActiveX server method. |
| Output | ||
| Name | Type | Description |
| locale | LCID | The locale that the ActiveX server uses. |
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 5.0 and later