FPGenGetParamCtrlWidth
- Updated2023-02-21
- 2 minute(s) read
FPGenGetParamCtrlWidth
LabWindows/CVI ActiveX Server Interface
CVI_AppFPGenGetParamCtrlWidth (CAObjHandle objectHandle, ERRORINFO *errorInfo, long treeId, long nodeIdx, SAFEARRAY **widthArray, 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
Gets the widths of the parameter controls on the specified function panel. The width of the return value control, if it exists, is always stored as the last element in the array.
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. |
| treeId | long | Specifier for a particular function tree that is currently in memory. Obtain this ID from FPGenCreateFunctionTree or FPGenOpenFunctionTree. |
| nodeIdx | long | The one-based index of the node containing the function whose parameter control widths you want to get. |
| 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. |
| widthArray | SAFEARRAY ** | Array of the widths of the controls on the function panel. The values in this array are long integers. The Array Functions class in the LabWindows/CVI ActiveX Library contains functions to convert a safe array into a C-style array. If you do not convert the safe array into a C-style array, you must free the safe array using the LabWindows/CVI ActiveX Library CA_SafeArrayDestroy function. |
| 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. |