Admin Production ni-theme
Current Publication

OperateSplitter

LabWindows/CVI

OperateSplitter

int OperateSplitter (int panelHandle, int controlID, int delta);

Purpose

Use this function to mimic the movement of a splitter control by the interactive user. The effect is to move the splitter by a specified amount, and to also size or move any controls or panels that are attached to the splitter.

Supported Controls

You can use OperateSplitter with splitter 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.
delta int The number of pixels you want to offset the position of the splitter control.

If this is a vertical splitter and this value is negative, then the splitter will shift to the left; if the value is positive, the splitter will shift to the right. If this is a horizontal splitter, and this value is negative, then the splitter will shift up; if the value is positive, then the splitter will shift down.

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 7.1 and later

Examples

Refer to the following examples that use the OperateSplitter function:

  • apps\uirview\uirview.cws

    Open example
  • userint\docking.cws

    Open example
  • userint\events.cws

    Open example