GenerateFunctionTreeFromHeaderFile
- Updated2023-02-21
- 3 minute(s) read
GenerateFunctionTreeFromHeaderFile
LabWindows/CVI ActiveX Server Interface
CVI_AppGenerateFunctionTreeFromHeaderFile (CAObjHandle objectHandle, ERRORINFO *errorInfo, const char *instrName, const char *fnPrefix, const char *fnQualifier, const char *inputHeaderPath, const char *functionTreePath, const char *cleanedUpHeaderPath, 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 a function tree from a header file.
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. |
| instrName | const char * | The name of the function tree to generate. |
| fnPrefix | const char * | The common prefix for functions in the function tree. The first character in the prefix can be a letter or an underscore only. All of the rest of the characters in the prefix can be an alphanumeric character or an underscore. If you use an underscore in the header file to separate the prefix from the function name, you also must include an underscore in fnPrefix. |
| fpQualifier | const char * | The default qualifier for functions in the function tree. |
| inputHeaderPath | const char * | The absolute pathname of the header file from which to create the function tree. |
| functionTreePath | const char * | The absolute pathname of the generated function panel file. |
| cleanedUpHeaderPath | const char * | The absolute pathname of the generated header file. This header file is identical to the one used to generate the function tree except that all of the special tags used to specify function tree generation options are removed. LabWindows/CVI preserves white space from the input header file in the generated header file. |
| 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 error occurred. A negative error code indicates function failure. 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. |