Admin Production ni-theme
Current Publication

GetActiveCtrl

LabWindows/CVI

GetActiveCtrl

int GetActiveCtrl (int panelHandle);

Purpose

Obtains the ID of the active control on the specified panel.

The active control is the control that receives keyboard events when the panel is the active panel.

Parameters

Input
Name Type Description
panelHandle int Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel.

Return Value

Name Type Description
controlID int Returns the control ID of the active control. If the panel has no controls, GetActiveCtrl returns zero.

GetActiveCtrl can return the following error code:

4—Panel, pop-up, menu bar, or plot ID is invalid.

Additional Information

Library: User Interface Library

Include file: userint.h

LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later

Example

Refer to userint\clipbord.cws for an example of using the GetActiveCtrl function.