GenerateActiveXController

Download PDF

Updated2023-02-21
3 minute(s) read

LabWindows/CVI ActiveX Server Interface

CVI_AppGenerateActiveXController (CAObjHandle objectHandle, ERRORINFO *errorInfo, const char *serverName, const char *instrPrefix, const char *targetFpFile, enum CVIEnum_CVIActiveXServerCompatibility compatibilityOption, long addFpFileToProject, long *returnValue);

Note This function signature is shown as it appears when you create a client using the LabWindows/CVI ActiveX Controller Wizard. If you create a client for the LabWindows/CVI ActiveX server interface using a different development environment, this function might be exposed differently. Some of the parameters documented here, such as objectHandle or errorInfo, are not applicable if you write a client using a different development environment.

Purpose

Generates an ActiveX controller wrapper in the form of an instrument driver.

Parameters

Input
Name	Type	Description
objectHandle	CAObjHandle	Specifier for a particular ActiveX object that is currently in memory. Obtain this handle from CVI_NewApp, CVI_OpenApp, CVI_ActiveApp, or an ActiveX method or property. All of the methods that you can apply to a particular object are grouped under a single class in the function tree. The name of the class corresponds to the type of the object to which this handle refers.
serverName	const char *	The name of the server for which to generate an ActiveX controller. You must specify a server that is registered on the computer on which this function is called.
instrPrefix	const char *	The instrument prefix for the ActiveX controller instrument driver. The prefix you specify can contain only alphanumeric characters or underscores. This function prefixes various source code identifiers with this string when it generates the instrument driver.
targetFpFile	const char *	The absolute pathname of the .fp file into which LabWindows/CVI generates the instrument function panels. This function creates source (.c) and header (.h) files in the same directory and with the same base filename as the .fp file. You can specify either a new file or an existing file. If you specify an existing file, this function overwrites the contents of the .fp, source (.c), and header (.h) files.
compatibilityOption	enum CVIEnum_CVIActiveXServerCompatibility	Specifies how the wizard generates functions to access properties of objects in the server. You can specify one of the following constants: CVI_ACTIVEX_SERVER_COMPATIBILITY_PROPFUNCGENMETHOD_PERSERV (0)—Generates common Get, Put, and PutByRef functions at the top level for all properties. CVI_ACTIVEX_SERVER_COMPATIBILITY_PROPFUNCGENMETHOD_PEROBJ (1)—Generates a Get, Put, and PutByRef function for each object to handle its properties. CVI_ACTIVEX_SERVER_COMPATIBILITY_PROPFUNCGENMETHOD_PERPROP (2)—Generates a Get, Put, and PutByRef function for each property. In all cases where this value is used, the selected interfaces should not have any properties. Any properties will have been converted to methods when reading the type library. Those methods will serve as the "per property" access functions.
addFpFileToProject	long	Specifies whether to add the .fp file that this function generates to the current project. 0 = do not add the generated .fp file to the current project 1 = add the generated .fp file to the current project

Output
Name	Type	Description
errorInfo	ERRORINFO *	When an ActiveX server function fails with the error code DISP_E_EXCEPTION, descriptive information about the error code is stored in this parameter. The information can include the error code, source, and description. It also can include a help file and help file context ID. When an ActiveX server function fails with the error codes DISP_E_PARAMNOTFOUND, DISP_E_TYPEMISMATCH, or E_INVALIDARG, the parameter position of the invalid argument may be stored in the errorParamPos member of this parameter. You can pass NULL for this parameter.
returnValue	long *	The value that the LabWindows/CVI ActiveX server function returns. A negative value indicates that the LabWindows/CVI ActiveX server function returned an error. You can use GetCVIAutomationServerErrorString to get the description of a LabWindows/CVI ActiveX server error code.

Return Value

Name	Type	Description
status	HRESULT	A value indicating whether an ActiveX Library error occurred. Error codes are defined in CVIversion\include\cviauto.h and <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h. You can use CA_GetAutomationErrorString to get the description of an ActiveX Library error code.