Admin Production ni-theme
Current Publication

CA_ServerGetTypeInfo

LabWindows/CVI

CA_ServerGetTypeInfo

HRESULT CA_ServerGetTypeInfo (IDispatch *thisInterfacePtr, unsigned long typeInfoIndex, LCID locale, ITypeInfo **typeInfoPtr);

Purpose

Implementation of the IDispatch::GetTypeInfo method used in the ActiveX servers generated by the ActiveX Server Wizard.

Parameters

Input
Name Type Description
thisInterfacePtr IDispatch * The IDispatch interface pointer of your ActiveX object.
typeInfoIndex unsigned long The type information to return. Pass 0 to retrieve type information for the IDispatch implementation.
locale LCID The locale identifier for the type information.
Output
Name Type Description
typeInfoPtr ITypeInfo * The ITypeInfo interface pointer for the requested type information.

Return Value

Name Type Description
status HRESULT A value indicating whether an error occurred. Function failure is indicated by a negative error code.

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 the COM runtime and passed on to you by the 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.

Note   You should not return the ActiveX Library error codes from your ActiveX server to your ActiveX clients, unless you document them in your server documentation. An acceptable compromise in this case is to return E_UNEXPECTED to the clients.

The error codes defined in <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h are too numerous to display here. These error codes can be returned to your ActiveX clients.

Additional Information

Library: ActiveX Library

Include file: cviauto.h

LabWindows/CVI compatibility: LabWindows/CVI 6.0 and later