Admin Production ni-theme
Current Publication

DiscardCtrl

LabWindows/CVI

DiscardCtrl

int DiscardCtrl (int panelHandle, int controlID);

Purpose

Removes a control from the specified panel and from memory.

You cannot discard a control in the callback function for the control, except when responding to the EVENT_COMMIT event. Discarding the control from its own callback function in response to other events might cause unpredictable behavior.

Supported Controls

You can use DiscardCtrl with all LabWindows/CVI user interface controls.

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.
controlID int The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl.

Return Value

Name Type Description
status int Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Additional Information

Library: User Interface Library

Include file: userint.h

LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later